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

Add a readme #19

Closed
jhaynes opened this issue May 30, 2019 · 3 comments
Closed

Add a readme #19

jhaynes opened this issue May 30, 2019 · 3 comments

Comments

@jhaynes
Copy link
Contributor

jhaynes commented May 30, 2019

We need an overall readme for the project that we can iterate on. We also need component specific documentation within each rust project and as part of the build system.

@iliana
Copy link
Contributor

iliana commented May 30, 2019

Component-specfic docs likely belong in a top-level docs/ as Markdown.

@tjkirch
Copy link
Contributor

tjkirch commented May 30, 2019

I'd prefer to keep component-specific docs in the component's directory, because it seems more obvious to get a nice README when you navigate to the component rather than having to navigate back to the top level /docs. It's also easier to use tools like cargo-readme to keep rustdoc in sync with READMEs.

@zmrow
Copy link
Contributor

zmrow commented Sep 3, 2019

Closing this in favor of #189 which adds user-level README's to the various places as well as the overall README

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

4 participants