We use Confluence to document everything.
- write down a blog post if you think other people will use something you learned
- very wide net of what goes into docs
Yuka Storybook after you make a change to the yuka component itself A whole different environment
- potentially ask Ashley about stuff that needs to be updated on storybook
- Really good tool, but not a priority
- Sam also good to reach out for yuka
**API Auto generated documentation help_text
We should add help_text whenever we make models in django Catch all documentation about the code that isn’t in the code literally Notes we have about product
localhost:8001/api/docs
Docstring
Most of the code documentation is in docstrings
"""
Returns the tickets that a staff user can see Note that this logic does presume that certain staff permissions are linked together to provide certain optimizations. We may need
to rewrite the logic if we have different permissions for staff or for external users regarding global visibility Note: if updated in the future, the connection visibility restrictions for Market Operators based on the connection stage should be included. """“
Some are inline documentations
CHANGELOG_DB.md For when you update the DB schema
CHANGELOG_API for when you change the API
Styleguides https://google.github.io/styleguide/pyguide.html https://google.github.io/styleguide/jsguide.html#jsdoc