-
Notifications
You must be signed in to change notification settings - Fork 1
Update README #1
Copy link
Copy link
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationgood for newcomersGood for newcomersGood for newcomers
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationgood for newcomersGood for newcomersGood for newcomers
Type
Fields
Give feedbackNo fields configured for issues without a type.
Projects
Status
For Review
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.mdfile 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
# CCSS HandbookAdd Setup Instructions
Add Formatting Instructions
(Optional) Add a contribution note with a link to the relevant section of the handbook, if available
✅ Acceptance Criteria
README.mdtitle is updated toCCSS Handbooknpm install,npm run start) are listednpm run format) are listed