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

Move all documentation to this repo #4

Open
tsuberim opened this issue Apr 9, 2018 · 2 comments
Open

Move all documentation to this repo #4

tsuberim opened this issue Apr 9, 2018 · 2 comments
Assignees
Labels
enhancement New feature or request

Comments

@tsuberim
Copy link
Contributor

tsuberim commented Apr 9, 2018

Make this repo the only place for documentation for the entire DAOstack project.

How it will work:

  • Documentation from all subprojects will be in this repo in a seperate folder (/arc for Arc, /arc-js for Arc.js)
  • Documentation generated from source code will be generated locally and committed to this repo (not committed to subproject repo).
  • A CI service will compile and deploy a single website to the gh-pages branch of this repo.

Benefits:

  • Easy to document cross-cutting concerns (e.g. an end-to-end tutorial on how to use the whole DAOstack together).
  • Easier linking between subprojects (with the ability to check for broken links between subprojects).
  • Consistent look & feel using the same website.
  • Removing unnecessary complexity from the subprojects repos i.e managing the website.
  • Supports switching markdown compilers if we need to in the future (e.g. switch to Jekyll or read the docs) or changing the behavior of the website.
@tsuberim tsuberim added the enhancement New feature or request label Apr 9, 2018
@tsuberim tsuberim self-assigned this Apr 9, 2018
@dkent600
Copy link

@dev-matan-tsuberi Can you describe how one does the "generated locally and committed to this repo" part? Thanks.

@tsuberim
Copy link
Contributor Author

@dkent600 This is sub-project specific. In arc.js for example you would use typedoc to generate the markdown, in Arc wer'e using soldoc. Once generated you'd commit the markdown to docs to publish it.

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

No branches or pull requests

2 participants