Skip to main content

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:

  1. Go to the website/docs/developer directory
  2. Create a new Markdown file (.md)
  3. Write your documentation in that file
  4. That’s it πŸŽ‰ β€” it will automatically appear in the sidebar

πŸ’‘ The sidebars.js file 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! ✨