-
Notifications
You must be signed in to change notification settings - Fork 1
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationgood for newcomersGood for newcomersGood for newcomers
Description
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
-
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.")
- Replace the default heading with
-
Add Setup Instructions
npm install npm run start
-
Add Formatting Instructions
npm run format
-
(Optional) Add a contribution note with a link to the relevant section of the handbook, if available
✅ Acceptance Criteria
-
README.md
title is updated toCCSS 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
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationgood for newcomersGood for newcomersGood for newcomers
Type
Projects
Status
For Review