-
Notifications
You must be signed in to change notification settings - Fork 519
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
Comments
Component-specfic docs likely belong in a top-level |
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. |
Closing this in favor of #189 which adds user-level README's to the various places as well as the overall README |
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.
The text was updated successfully, but these errors were encountered: