Documentation
Open
Nobody has claimed this yet.
- Dominant language
- Jai
- Stars
- 10
- Forks
- 0
- Avg merge
- 1m
- Merged PRs (30d)
- 1
Description
Document these:
- general architecture
- layout system
- renderer (primitive types, SDF)
- styling/themes
- text
- widgets
I'm not sure if I should just add documentation to the code, or in separate .md files, or both, and if we should use a generator.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by surveying the project to map its general architecture, layout system, renderer, styling/themes, text, and widgets. No files, tests, documentation format, or generator are identified in the issue, so first clarify where documentation should live and what scope is expected. Done means all six areas are documented in the agreed format.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Active
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100