Docs
Welcome to the Purrsistence documentation! This space includes:
- π Developer Documentation
- π§ Project Decisions for the course FSSD
- β Additional project-related resources
Use the sidebar to explore the different sections of the documentation.
π©βπ» For Developersβ
To contribute developer documentation:
- Go to the
website/docs/developerdirectory - Create a new Markdown file (
.md) - Write your documentation in that file
- Thatβs it π β it will automatically appear in the sidebar
π‘ The
sidebars.jsfile is already configured to include all files in this directory.
π§ͺ Preview the Docs Website Locallyβ
If you want to test your changes locally before pushing:
cd website
npm install
npm run start
This will start a local development server so you can preview your changes in real time.
Happy documenting! β¨