docs: revise README structure and content #1417

tyler-dane · 2026-01-21T02:44:25Z

Updated README with new headings and simplified content.

Note

Low Risk
Documentation-only changes to README.md with no runtime or behavioral impact.

Overview
Refreshes README.md with new positioning copy and a clearer structure (Why Compass → Features → Getting Started).

Replaces the old “Benefits/Next Steps” layout with categorized feature lists (Unique Stuff, Essentials, Current Limitations), adds direct links for trying the hosted app, roadmap, and contribution guidance, and introduces a concise Tech Stack + community/resources section.

^{Written by Cursor Bugbot for commit 7ce75a7. This will update automatically on new commits. Configure here.}

Updated README with new headings and simplified content.

Copilot

Pull request overview

This pull request restructures the README to simplify the presentation of benefits by removing the "Benefits" section heading and converting subsection headings into inline bold format. The changes also reorganize media placement and streamline content.

Changes:

Converted "Benefits" section from structured headings to inline bold format for a more compact presentation
Simplified benefit descriptions and moved the image to follow the benefits list
Removed secondary tagline "All your tasks & events in one place"

README.md

Updated the README to enhance clarity and detail about the Compass Calendar features and usage.

Copilot

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 3 comments.

Copilot · 2026-01-21T03:47:22Z

README.md

+We love contributions! Whether it's bug fixes, new features, or documentation improvements, your help makes Compass better for everyone.

- 📘 [Read the handbook](https://compasscalendar.notion.site/?utm_source=github&utm_medium=referral&utm_campaign=readme): Why Compass exists and how it fits into our loooooong-term vision.
+Issues: Check open issues or create a new one.


Missing markdown formatting for "Issues:" as a bullet point. This line should be formatted as a bullet point (starting with "-") to match the formatting of "Pull Requests:" and "Discussions:" on the following lines.

Suggested change

Issues: Check open issues or create a new one.

- Issues: Check open issues or create a new one.

Copilot · 2026-01-21T03:47:23Z

README.md

+Issues: Check open issues or create a new one.
+Pull Requests: Fork the repo, make your changes, and submit a PR. Follow our [Contribution Guidelines](https://docs.compasscalendar.com/docs/contribute).
+Discussions: Join the conversation on GitHub Discussions.


Missing markdown formatting for "Pull Requests:" and "Discussions:" as bullet points. These lines should be formatted as bullet points (starting with "-") to maintain consistent list formatting with the rest of the Contributing section.

Suggested change

Issues: Check open issues or create a new one.

Pull Requests: Fork the repo, make your changes, and submit a PR. Follow our [Contribution Guidelines](https://docs.compasscalendar.com/docs/contribute).

Discussions: Join the conversation on GitHub Discussions.

- Issues: Check open issues or create a new one.

- Pull Requests: Fork the repo, make your changes, and submit a PR. Follow our [Contribution Guidelines](https://docs.compasscalendar.com/docs/contribute).

- Discussions: Join the conversation on GitHub Discussions.

Copilot · 2026-01-21T03:47:23Z

README.md

+Discussions: Join the conversation on GitHub Discussions.

- 👀 Stay in touch: [GitHub Discussions](https://github.com/SwitchbackTech/compass/discussions), [X (Twitter)](https://x.com/CompassCalendar), [YouTube](https://youtube.com/playlist?list=PLPQAVocXPdjmYaPM9MXzplcwgoXZ_yPiJ&si=jssXj_g9kln8Iz_w), [LinkedIn](https://www.linkedin.com/company/compass-calendar)
+First-time contributors? Look for issues labeled "good first issue"!


Missing markdown formatting. This line should be a bullet point (starting with "-") to maintain consistent list formatting with the other items in the "First-time contributors?" paragraph.

Suggested change

First-time contributors? Look for issues labeled "good first issue"!

- First-time contributors? Look for issues labeled "good first issue"!

Copilot

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 6 comments.

Copilot · 2026-02-01T19:41:59Z

README.md

+Issues: Check open issues or create a new one.
+Pull Requests: Fork the repo, make your changes, and submit a PR. Follow our [Contribution Guidelines](https://docs.compasscalendar.com/docs/contribute).
+Discussions: Join the conversation on GitHub Discussions.


The formatting of this section is inconsistent with standard Markdown list syntax. Each item should start with a hyphen and space on a new line, rather than being presented as a paragraph with labels. This makes it harder to read and inconsistent with the rest of the document which uses proper list formatting.

Suggested change

Issues: Check open issues or create a new one.

Pull Requests: Fork the repo, make your changes, and submit a PR. Follow our [Contribution Guidelines](https://docs.compasscalendar.com/docs/contribute).

Discussions: Join the conversation on GitHub Discussions.

- Issues: Check open issues or create a new one.

- Pull Requests: Fork the repo, make your changes, and submit a PR. Follow our [Contribution Guidelines](https://docs.compasscalendar.com/docs/contribute).

- Discussions: Join the conversation on GitHub Discussions.

Copilot · 2026-02-01T19:41:59Z

README.md

-![Jest](https://img.shields.io/badge/-jest-%23C21325?style=for-the-badge&logo=jest&logoColor=white)
-![Testing-Library](https://img.shields.io/badge/-TestingLibrary-%23E33332?style=for-the-badge&logo=testing-library&logoColor=white)
-![Ngrok](https://img.shields.io/badge/ngrok-1F1F1F?style=for-the-badge&logo=ngrok&logoColor=white)
+Star the repo for good luck.


Missing a period at the end of the sentence. The other list items in the "Community & Resources" section (lines 85-87) have closing punctuation, so this line should as well for consistency.

Copilot · 2026-02-01T19:42:00Z

README.md

+- **Private & Offline**: Runs fully local in your browser, with optional Google Calendar sync.
+- **No bloat**: No AI — just a clean, minimal interface to help you get things done.
+
+Join thousands of engineers who are staying organized and productive with Compass.


This claim of "thousands of engineers" should be verified. Marketing claims about user numbers should be factual and verifiable to maintain credibility. If this is an aspirational statement rather than a factual one, consider revising to be more accurate or removing the specific number.

Suggested change

Join thousands of engineers who are staying organized and productive with Compass.

Join engineers who are staying organized and productive with Compass.

Copilot · 2026-02-01T19:42:00Z

README.md

- 📃 [Read the technical docs](https://docs.compasscalendar.com?utm_source=github&utm_medium=referral&utm_campaign=readme): All the info you'd need to get started, including guides on how to install, test, build, deploy, and contribute.
+Issues: Check open issues or create a new one.
+Pull Requests: Fork the repo, make your changes, and submit a PR. Follow our [Contribution Guidelines](https://docs.compasscalendar.com/docs/contribute).
+Discussions: Join the conversation on GitHub Discussions.


The "GitHub Discussions" reference lacks a link. Line 78 mentions joining the conversation on GitHub Discussions but doesn't provide a URL, unlike all other community resources which have proper hyperlinks. This should include a link to https://github.com/SwitchbackTech/compass/discussions for consistency with the other resources in this section and the old README which had this link.

Suggested change

Discussions: Join the conversation on GitHub Discussions.

Discussions: Join the conversation on [GitHub Discussions](https://github.com/SwitchbackTech/compass/discussions).

Copilot · 2026-02-01T19:42:00Z

README.md

-## Tech Stack
+- **Handbook**: [compasscalendar.notion.site](https://compasscalendar.notion.site/Compass-Handbook-26b237bde8f4805c9a56de6db3a7993d/?utm_source=github&utm_medium=referral&utm_campaign=readme)
+- **Twitter**: [@CompassCalendar](https://x.com/CompassCalendar)
+- **Youtube**: [Playlist](https://youtube.com/playlist?list=PLPQAVocXPdjmYaPM9MXzplcwgoXZ_yPiJ&si=jssXj_g9kln8Iz_w)


Spelling error: "Youtube" should be "YouTube" with proper capitalization. This is the official brand name and should be capitalized correctly.

Suggested change

- **Youtube**: [Playlist](https://youtube.com/playlist?list=PLPQAVocXPdjmYaPM9MXzplcwgoXZ_yPiJ&si=jssXj_g9kln8Iz_w)

- **YouTube**: [Playlist](https://youtube.com/playlist?list=PLPQAVocXPdjmYaPM9MXzplcwgoXZ_yPiJ&si=jssXj_g9kln8Iz_w)

Copilot · 2026-02-01T19:42:00Z

README.md


- 📃 [Read the technical docs](https://docs.compasscalendar.com?utm_source=github&utm_medium=referral&utm_campaign=readme): All the info you'd need to get started, including guides on how to install, test, build, deploy, and contribute.
+Issues: Check open issues or create a new one.
+Pull Requests: Fork the repo, make your changes, and submit a PR. Follow our [Contribution Guidelines](https://docs.compasscalendar.com/docs/contribute).


The Contribution Guidelines link path is inconsistent with the actual path in CONTRIBUTING.md. The README links to "https://docs.compasscalendar.com/docs/contribute" but CONTRIBUTING.md shows the correct path is "https://docs.compasscalendar.com/docs/how-to-contribute/contribute". This could lead to a broken link or incorrect redirect.

Suggested change

Pull Requests: Fork the repo, make your changes, and submit a PR. Follow our [Contribution Guidelines](https://docs.compasscalendar.com/docs/contribute).

Pull Requests: Fork the repo, make your changes, and submit a PR. Follow our [Contribution Guidelines](https://docs.compasscalendar.com/docs/how-to-contribute/contribute).

Revise README structure and content

d94286f

Updated README with new headings and simplified content.

Copilot AI review requested due to automatic review settings January 21, 2026 02:44

tyler-dane assigned Copilot Jan 21, 2026

Copilot started reviewing on behalf of tyler-dane January 21, 2026 02:44 View session

Copilot AI reviewed Jan 21, 2026

View reviewed changes

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

Revise README for improved clarity and detail

602e50d

Updated the README to enhance clarity and detail about the Compass Calendar features and usage.

Copilot AI review requested due to automatic review settings January 21, 2026 03:45

Copilot started reviewing on behalf of tyler-dane January 21, 2026 03:46 View session

Copilot AI reviewed Jan 21, 2026

View reviewed changes

tyler-dane added 2 commits February 1, 2026 11:35

Merge branch 'main' into tyler-dane-patch-1

686e684

Update README for improved clarity and detail on features and usage

7ce75a7

Copilot AI review requested due to automatic review settings February 1, 2026 19:40

Copilot started reviewing on behalf of tyler-dane February 1, 2026 19:40 View session

tyler-dane merged commit 8fe0a81 into main Feb 1, 2026
10 checks passed

tyler-dane deleted the tyler-dane-patch-1 branch February 1, 2026 19:40

tyler-dane changed the title ~~Revise README structure and content~~ docs: revise README structure and content Feb 1, 2026

Copilot AI reviewed Feb 1, 2026

View reviewed changes

	Issues: Check open issues or create a new one.
	- Issues: Check open issues or create a new one.

	First-time contributors? Look for issues labeled "good first issue"!
	- First-time contributors? Look for issues labeled "good first issue"!

	Join thousands of engineers who are staying organized and productive with Compass.
	Join engineers who are staying organized and productive with Compass.

	Discussions: Join the conversation on GitHub Discussions.
	Discussions: Join the conversation on [GitHub Discussions](https://github.com/SwitchbackTech/compass/discussions).

	- Youtube: [Playlist](https://youtube.com/playlist?list=PLPQAVocXPdjmYaPM9MXzplcwgoXZ_yPiJ&si=jssXj_g9kln8Iz_w)
	- YouTube: [Playlist](https://youtube.com/playlist?list=PLPQAVocXPdjmYaPM9MXzplcwgoXZ_yPiJ&si=jssXj_g9kln8Iz_w)

	Pull Requests: Fork the repo, make your changes, and submit a PR. Follow our [Contribution Guidelines](https://docs.compasscalendar.com/docs/contribute).
	Pull Requests: Fork the repo, make your changes, and submit a PR. Follow our [Contribution Guidelines](https://docs.compasscalendar.com/docs/how-to-contribute/contribute).

docs: revise README structure and content #1417

docs: revise README structure and content #1417

Uh oh!

Conversation

tyler-dane commented Jan 21, 2026 • edited by cursor bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Jan 21, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 21, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 21, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Feb 1, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 1, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 1, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 1, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 1, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 1, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

tyler-dane commented Jan 21, 2026 •

edited by cursor bot

Loading