Skip to content
- Any information relating to the codebase that a developer will
need to know in order to set up and start working.
- Deployment instructions including what to do if they fail.
- Useful project-related links.
- Where are staging & production?
- Where is the runbook?
- Anything about the day-to-day running and maintenance of a project.
- Any information about regular tasks or support issues.
- Quick links to staging, production, logs, third-parties.
- Any technical decisions, architectural knowledge, useful diagrams,
postman collections etc. should live in a
/docs folder at the top
level of a project.
