📄 Documentation

note

Documentation should be at the front of what we do and therefore it exists right alongide the codebase, to make it easier to contribute.

Ideally we will reseach and document, prior to implementing a feature etc.

Conway's Law

Any organization that designs a system (defined broadly) will produce a design whose structure is a copy of the organization's communication structure.

— Melvin E. Conway

Folder Structure

rentreef # root directory of your site
├── 📁 main # next.js & storybook
│
└── 📁 app-docs # documentation
    ├── docs # main folder for docs
    ├── src # react style components
    ├── static # assets
    └── docusaurus.config.js # config