Astrotomic / Astrotomic/stancy

Write documentation

Open
#17 0 comments 0 reactions 0 assignees View on GitHub
documentation good first issue hacktoberfest help wanted
Dominant language
PHP
Stars
35
Forks
3
PR merge metrics
No merged PRs in 30d

Description

The whole documentation is missing and should be added.
It should cover basic usage but also have sections for every single component which describes it in detail for more advanced usage.

Every single improvement is welcome, so don't mind if you only add a single sentence or a whole section.
Atm the unittests are a good place to see some usage examples. But also the demo apps should get more content to look at.
If there are any questions I will ry to answer all of them.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the unit tests for usage examples and the demo apps to understand the project surface. Define a documentation structure covering basic usage and a detailed section for every component, then expand the demo-app content. Done means the requested coverage exists and explains both basic and advanced usage.

Written by the indexing model from the issue text.

Assessment

Tech stack
laravel, php
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.