Skip to content

Commit 8306d2b

Browse files
committed
Update Docusaurus configuration and documentation for clarity and consistency
- Changed the tagline in docusaurus.config.js to reflect the updated focus on the task manager for engineers. - Replaced the hardcoded handbook URL with a constant imported from src/constants.js for better maintainability. - Deleted the outdated roadmap.md file and created a new roadmap.mdx file linking to the handbook for improved accessibility. - Added a new contribute.mdx file outlining contribution guidelines and expectations, emphasizing alignment with project goals. - Introduced src/constants.js to centralize external URLs and constants.
1 parent ec01804 commit 8306d2b

6 files changed

Lines changed: 34 additions & 22 deletions

File tree

.github/copilot-instructions.md

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

33
**ALWAYS follow these instructions first.** Only fallback to additional search and context gathering if the information in these instructions is incomplete or found to be in error.
44

5-
Compass Docs is a Docusaurus v3.x documentation site for the Compass calendar application. It provides comprehensive documentation for developers and users of the open-source calendar for minimalists.
5+
Compass Docs is a Docusaurus v3.x documentation site for the Compass task manager. It provides comprehensive documentation for developers and users of the open-source task manager for engineers.
66

77
## Branch Naming & Commit Message Conventions
88

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
sidebar_position: 1
33
---
44

5+
import { HANDBOOK_URL } from "../../src/constants.js";
6+
57
# How to Contribute
68

79
## Setting Expectations
@@ -11,42 +13,42 @@ We're laser-focused on two things:
1113
1. Helping minimalists manage their schedule and focus, so they can do more of what matters
1214
2. Being profitable, so that we can continue doing #1 for decades
1315

14-
We're only accepting contributions that help us reach those goals. If you submit a PR that doesn't align with our goals, it will be rejected. The best way to avoid this scenario is to confirm that your proposed changes align with our priorities. You can verify this by reviewing the [Roadmap](../roadmap.md) and timeline (more links and details on how to do this below).
16+
We're only accepting contributions that help us reach those goals. If you submit a PR that doesn't align with our goals, it will be rejected. The best way to avoid this scenario is to confirm that your proposed changes align with our priorities. You can verify this by reviewing the [Roadmap](../roadmap.mdx) and timeline (more links and details on how to do this below).
1517

1618
If these goals align with your own, we'd love to work with you!
1719

1820
### What's in it for you
1921

20-
#### 🚀 Experience
22+
#### Experience
2123

2224
Working on Compass gives you unique experience that you won't get anywhere else.
2325

2426
- **Meritocracy**: Compass operates on outputs, not resumes or locales. An Ex-Googler in SF gets the same treatment as someone in Mongolia who just learned HTML; We only care about the quality of the work you can produce.
2527

2628
- **Fullstack**: Since this is an open-source monorepo, you can get experience getting things to work end-to-end without silos. This'll help you become a true fullstack engineer.
2729

28-
- **Transparency**: Code isn't the only thing that we're transparent about. We publish our [handbook](https://compasscalendar.notion.site/), roadmap, technical guides, and lessons-learned across our repos and social media. Working in an open culture will give you more opportunities to grow as an engineer and leader.
30+
- **Transparency**: Code isn't the only thing that we're transparent about. We publish our <a href={HANDBOOK_URL} target="_blank" rel="noopener noreferrer">handbook</a>, roadmap, technical guides, and lessons-learned across our repos and social media. Working in an open culture will give you more opportunities to grow as an engineer and leader.
2931

30-
#### 🏆 Recognition
32+
#### Recognition
3133

3234
What may be offered after consistent excellence\*:
3335

34-
- 📝 Reference for your next job
35-
- 📈 Compensation
36-
- 📈 Preference for future opportunities @ Switchback (the company behind Compass)
36+
- Reference for your next job
37+
- Compensation
38+
- Preference for future opportunities @ Switchback (the company behind Compass)
3739

3840
\*These are the criteria we use to assess the quality of your work. If you don't meet these criteria, we may reject your PR.
3941

4042
1. **Code quality**: Is the code readable, well-organized, and testable? Does it follow best practices? Does it provide good UX?
41-
2. **Expertise**: Does your work reflect your skill level? Did you need a lot of technical guidance in order to get started? Were you able to make good judgments about the requirements and implementation?
42-
3. **Communication**: If you got blocked, did you reach out for help? Did you communicate your plans and progress clearly? Are your commits, PR descriptions, and comments easy to understand?
43+
2. **Expertise**: Does your work reflect your skill level? Did you need a lot of technical guidance in order to get started? Were you able to make good judgments about the requirements and implementation?
44+
3. **Communication**: If you got blocked, did you reach out for help? Did you communicate your plans and progress clearly? Are your commits, PR descriptions, and comments easy to understand?
4345
4. **Reliability**: Did you submit your PR, update based on comments in a timely manner? If something came up that prevented you from completing a PR on time, did you let us know?
4446

4547
## Workflows
4648

47-
### 🏁 You're ready to pick up a new task
49+
### You're ready to pick up a new task
4850

49-
1. Review the [roadmap](../roadmap.md) to confirm that the issue you'd like to work on is aligned with our goals
51+
1. Review the [roadmap](../roadmap.mdx) to confirm that the issue you'd like to work on is aligned with our goals
5052
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.
5153
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.
5254
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.
@@ -62,16 +64,16 @@ What may be offered after consistent excellence\*:
6264
1. Link the PR to the issue it solves by including the issue number in the PR description and using a [closing keyword](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/using-keywords-in-issues-and-pull-requests#linking-a-pull-request-to-an-issue). For example: `Fixes #123`
6365
1. Wait for feedback. You can continue this process with another issue while waiting for feedback.
6466

65-
### 🐞 You found an undocumented bug
67+
### You found an undocumented bug
6668

6769
- If the bug is a security vulnerability, please [report it here](https://github.com/SwitchbackTech/compass/security).
6870
- Ensure the bug was not already reported by searching under the issues
6971
- If it's a new bug, open a new issue, including as much relevant information as possible.
7072

71-
### ☝️ You want to add a new feature or dramatically change an existing one
73+
### You want to add a new feature or dramatically change an existing one
7274

73-
Larger features or changes that are not already on our [Roadmap](../roadmap.md) or in the backlog will most likely be rejected. If you're unsure, open a GitHub issue before you start working. This will help ensure that your work is aligned with the project's goals and that you don't spend time on something that won't be prioritized.
75+
Larger features or changes that are not already on our [Roadmap](../roadmap.mdx) or in the backlog will most likely be rejected. If you're unsure, open a GitHub issue before you start working. This will help ensure that your work is aligned with the project's goals and that you don't spend time on something that won't be prioritized.
7476

75-
### 💅 You fixed whitespace, formatted code, or made a purely cosmetic patch
77+
### You fixed whitespace, formatted code, or made a purely cosmetic patch
7678

7779
Changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability will generally not be accepted.

docs/roadmap.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/roadmap.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
import { HANDBOOK_URL } from "../src/constants.js";
2+
3+
# Roadmap
4+
5+
The roadmap has been moved to our <a href={HANDBOOK_URL} target="_blank" rel="noopener noreferrer">public handbook</a>.

docusaurus.config.js

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,13 @@
44
const lightCodeTheme = require("prism-react-renderer/themes/github");
55
const darkCodeTheme = require("prism-react-renderer/themes/dracula");
66

7+
// Import constants from central location
8+
const { HANDBOOK_URL } = require("./src/constants.js");
9+
710
/** @type {import('@docusaurus/types').Config} */
811
const config = {
912
title: "Compass Docs",
10-
tagline:
11-
"Learn how to use Compass, the open source calendar for minimalists.",
13+
tagline: "Learn how to use Compass, the task manager for engineers.",
1214
favicon: "img/favicon.ico",
1315
url: "https://docs.compasscalendar.com",
1416
// Set the /<baseUrl>/ pathname under which your site is served
@@ -112,7 +114,7 @@ const config = {
112114
},
113115
{
114116
label: "Handbook",
115-
href: "https://compasscalendar.notion.site/",
117+
href: HANDBOOK_URL,
116118
},
117119
{
118120
label: "Blog",

src/constants.js

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
// Central location for external URLs and constants
2+
const HANDBOOK_URL =
3+
"https://compasscalendar.notion.site/Compass-Handbook-26b237bde8f4805c9a56de6db3a7993d?source=copy_link";
4+
5+
module.exports = { HANDBOOK_URL };
6+
module.exports.HANDBOOK_URL = HANDBOOK_URL;

0 commit comments

Comments
 (0)