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

Consistent documentation #1187

Open
kvark opened this issue May 1, 2017 · 1 comment
Open

Consistent documentation #1187

kvark opened this issue May 1, 2017 · 1 comment

Comments

@kvark
Copy link
Member

kvark commented May 1, 2017

We have 3 sources of documentation right now:

  1. in-code
  2. in tree: /webrender/doc
  3. Github Wiki

It would be great to be consistent as well as bring some structure to the docs.

@nical
Copy link
Contributor

nical commented May 2, 2017

I think that it's fine to have the in-code and in-tree documentation side by side (the latter being good for long high-level explanations), I would really like the in-tree version to be included in the cargo generated doc(*). The wiki doc could move in the in-tree version (main change would be that you would need to pass reviews to change the doc).

Or we could move the in-tree doc to the wiki until cargo doc gains support for including markdown files.

*: Unfortunately it looks like this isn't possible yet without extensions, see rust-lang/cargo#739

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