Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Keeping documentation content up to date #106

Open
vansimke opened this issue May 8, 2019 · 0 comments
Open

Keeping documentation content up to date #106

vansimke opened this issue May 8, 2019 · 0 comments
Labels
discussion The issue is up for discussion

Comments

@vansimke
Copy link

vansimke commented May 8, 2019

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.

@vansimke vansimke added the discussion The issue is up for discussion label May 8, 2019
tomdye pushed a commit to tomdye/site that referenced this issue Sep 16, 2020
* TypeScript Cheat Sheet update
* broken image and redirect fix
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion The issue is up for discussion
Projects
None yet
Development

No branches or pull requests

1 participant