Skip to content

Update README #1

@MathyouMB

Description

@MathyouMB

As a contributor, I want the project’s README to reflect the purpose and setup of the handbook so that it’s clear how to get started and contribute.


🧠 Context

Right now, the README.md file is still the default one generated by Docusaurus. It doesn’t explain what the project is or how to run it locally.

Since this project is the CCSS Handbook, the README should clearly state that, and provide simple instructions for setup and formatting.


🛠️ Implementation Plan

  1. Update the README Title and Description

    • Replace the default heading with # CCSS Handbook
    • Add a short description of the handbook’s purpose (e.g. "The Carleton Computer Science Society internal handbook for volunteers and developers.")
  2. Add Setup Instructions

    npm install
    npm run start
  3. Add Formatting Instructions

    npm run format
  4. (Optional) Add a contribution note with a link to the relevant section of the handbook, if available


✅ Acceptance Criteria

  • README.md title is updated to CCSS Handbook
  • A short description of the project is included
  • Instructions for setup (npm install, npm run start) are listed
  • Instructions for formatting (npm run format) are listed
  • The file no longer includes any default Docusaurus placeholder content

Metadata

Metadata

Labels

Type

No type

Projects

Status

For Review

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions