Expanding documentation
See original GitHub issueLet me start of by saying that I think our documentation is great. However, I do believe there is room for improvement, and Id be willing to take on the task of improving it. What do you all think about polishing up and expanding our documentation?
Somethings I have considered so far:
- Clarify the Import Data Workflow section by providing a high level overview followed by the more lower level overview.
- Add an Export Data Workflow section. It might seem strange to the user that we have one, but not the other.
- Reviewing previous issues that provide good fixes to common problems. We can create a common issues/solutions section to place all this stuff in.
- In our doc strings we should emphasize the
why?
as well thewhat?
. Django does this well for some of their docs. - Clearly mention known implementation limitations.
- Add a contributing section that can explain in detail how to fork, install and run the tests against any of our supported DB’s (sqlite, postgres, mysql).
- We can clarify the DB’s that we support.
- Expanding doc strings. The hardest (and still kind of is) part for me when I joined this project, was the lack of documentation on some of the classes, such as
ModelDeclarativeMetaclass
. I think it would be nice if we describe what that class does, and why its important.
I have been reading this, so I’ll try to follow those guidelines as I move forward.
Any other areas where you think we can improve?
Also, I’m unfamiliar with readthedocs.io, but are the docs compiled locally and then uploaded to the site? Or is this integrated into the CI? If not, do we want it integrated into the CI?
Issue Analytics
- State:
- Created 5 years ago
- Reactions:4
- Comments:6 (3 by maintainers)
Top Results From Across the Web
Expanding responses | Stripe Documentation
Expanding responses. Learn how to reduce the number of requests you make to the Stripe API by expanding objects in responses. This guide ......
Read more >pandas.DataFrame.expanding — pandas 1.5.2 documentation
Provide expanding window calculations. Parameters. min_periodsint, default 1. Minimum number of observations in window required to have a value; otherwise, ...
Read more >Collapse or expand parts of a document - Microsoft Support
To collapse or expand all the headings in your document, right-click the heading and click Expand/Collapse > Expand All Headings or Collapse All...
Read more >Documentation as Art: Expanded Digital Practices - 1st Edition
Documentation as Art presents documentation as an expanded practice that is radically changing the ways in which to look at, participate in, and...
Read more >Expanding Documentation, or making the most of the cracks in ...
Expanding Documentation, or making the most of the cracks in the wall. Book chapter. Dekker, A., Giannachi, G. and Van Saaze, V. (2017)....
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
@andrewgy8 this sounds fantastic!
regarding readthedocs, I have updated integration to use webhooks, RTD should automatically create on push and branch create/delete actions. Ref: https://docs.readthedocs.io/en/latest/webhooks.html#github
Better documentation of API objects is required (see #1322).