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

Docs: Improve Veraison documentation #23

Open
yogeshbdeshpande opened this issue Nov 15, 2022 · 2 comments
Open

Docs: Improve Veraison documentation #23

yogeshbdeshpande opened this issue Nov 15, 2022 · 2 comments

Comments

@yogeshbdeshpande
Copy link
Contributor

Please describe the problem
Need to have a clear and crisp documentation on Veraison Repository.

For this need to
(a) Agree on a format/template for organizing documentation

(b) Evaluate tools that can support the requirement!

(c) Generate suitable README.md and a Veraison Book which has document internals!

@yogeshbdeshpande
Copy link
Contributor Author

Coming from
veraison/veraison#53

@deeglaze
Copy link
Collaborator

For organizing the documentation, it would be lovely to not need to centralize every repository's documentation here, and instead compile them into an anthology here. That would help make individual projects more self-contained for third-party contributions.

I'm going to suggest that each repo have a docs/ directory for which README.md or index.md are the entry points for a chapter/section dedicated to the repository.

Do y'all have other thoughts on documentation compilation, such as gh-pages for individual repositories to render their individual documentation, and perhaps a pandoc template for rendering into html/pdf?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants