dojo / dojo/site

Keeping documentation content up to date

Open
#106 0 comments 0 reactions 0 assignees View on GitHub
discussion
Dominant language
TypeScript
Stars
7
Forks
17
PR merge metrics
No merged PRs in 30d

Description

Currently, documentation, such as reference guides, are completely hand-written. Over time, this could become a maintenance challenge as Dojo's features evolve and develop since the guides have to be manually reviewed and updated.

Ideally, critical portions of documentation could be either automatically generated from the source code or supported by some sort of test to ensure that the documentation is still correct.

Please use this issue to record thoughts on the feasibility of this idea as well as capture ideas about how we might be able to implement it.

Contributor guide

No contributing guide indexed for this repository

Research direction

The issue names reference guides and the source code, but no specific files, tests, or entry points. Start by reviewing how the guides are maintained and how documentation relates to the TypeScript source; done would be a documented feasibility assessment and implementation plan.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.