Skip to content

Commit c375d21

Browse files
committed
Update documentation to enhance clarity and provide up-to-date resources
- Revised the README.md to include a link to the most current documentation in the Compass codebase. - Updated contribute.mdx to direct new contributors to the latest documentation, ensuring they have access to relevant resources while familiarizing themselves with the project.
1 parent 16eac02 commit c375d21

2 files changed

Lines changed: 2 additions & 2 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
The source code for the Compass documentation site.
44

5-
To see the Compass source code, visit: [SwitchbackTech/compass](https://github.com/SwitchbackTech/compass)
5+
To see the Compass source code, visit: [SwitchbackTech/compass](https://github.com/SwitchbackTech/compass). The most up-to-date, low-level documentation lives in the [Compass codebase docs](https://github.com/SwitchbackTech/compass/tree/main/docs).
66

77
## Installation
88

docs/contribute/contribute.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ What may be offered after consistent excellence\*:
5151
1. Review the [roadmap](../roadmap.mdx) to confirm that the issue you'd like to work on is aligned with our goals
5252
1. Review [the quarterly backlog](https://github.com/orgs/SwitchbackTech/projects/4/views/8). This is the view that shows each important issue by the quarter it's planned for.
5353
1. Review [the timeline](https://github.com/orgs/SwitchbackTech/projects/4/views/7) to confirm that you could finish the issue you'd like to work on before its deadline.
54-
1. If this is your first time contributing, pick an issue in the `Ready` state for the _next_ quarter that has a `Good first issue` tag. Working on an issue in the next quarter gives you time to familiarize yourself with the codebase while still working on a priority change. It also gives us the chance to assess the quality of work and your reliability before giving you more responsibility.
54+
1. If this is your first time contributing, pick an issue in the `Ready` state for the _next_ quarter that has a `Good first issue` tag. Working on an issue in the next quarter gives you time to familiarize yourself with the codebase while still working on a priority change. For the most up-to-date, low-level documentation, see the [docs in the Compass codebase](https://github.com/SwitchbackTech/compass/tree/main/docs). It also gives us the chance to assess the quality of work and your reliability before giving you more responsibility.
5555
1. Find an issue you'd like to work on. _If you can submit a PR for it before the `End` date assigned to it_: ask to have the issue reassigned to you in the issue comments. If you can't finish it on time, find another issue in the next quarter that you could.
5656
1. Ask any clarifying questions in the issue thread.
5757
1. Start working on the issue. (If you're a new contributor, we will NOT assign the issue to you before a PR is submitted. This helps us avoid holding an issue for an extended period of time.)

0 commit comments

Comments
 (0)