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

Refresh design documents and expose in rtd #809

Open
ethanfrey opened this issue Jun 25, 2019 · 0 comments
Open

Refresh design documents and expose in rtd #809

ethanfrey opened this issue Jun 25, 2019 · 0 comments
Labels
docs Time to write some documentation

Comments

@ethanfrey
Copy link
Contributor

Is your feature request related to a problem? Please describe.

https://weave.readthedocs.io/en/latest/index_old.html#weave-architecture gives an overview of the high-level design. However, this has not need refreshed for the latest 0.17 release and not ported over to the main index.rst file.

This is essential information to understand weave and should be easy to find.

Describe the solution you'd like

docs/design should be updated
index.rst should include all essential points
Add other sections as needed, such as orm, migrations, ???

@ethanfrey ethanfrey added the docs Time to write some documentation label Jun 25, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Time to write some documentation
Projects
None yet
Development

No branches or pull requests

1 participant