Improve documentation with comprehensive README and enhanced CLAUDE.md#8
Merged
Improve documentation with comprehensive README and enhanced CLAUDE.md#8
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
📝 WalkthroughWalkthroughRewrote and expanded project documentation in Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes 🚥 Pre-merge checks | ✅ 1✅ Passed checks (1 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Fix all issues with AI agents
In `@README.md`:
- Around line 59-61: Add blank lines around the "### Prerequisites" heading to
satisfy MD022: insert a single blank line before the "### Prerequisites" line
(so there is a blank line between "## Getting Started" and "### Prerequisites")
and ensure a blank line follows the "### Prerequisites" heading before the next
paragraph or list content.
- Around line 140-155: Add blank lines before and after the "Declination vs
Longitude" and "Out of Bounds (OOB)" headings in README.md to satisfy MD022;
specifically ensure there is an empty line above the "### Declination vs
Longitude" header and an empty line below it (before the next heading or
paragraph), and likewise add an empty line above and below the "### Out of
Bounds (OOB)" header so both headings are separated by blank lines from
surrounding content.
- Around line 109-112: Update the code fence under "## Project Structure" to
include a language identifier (e.g., change ``` to ```text) so the block
complies with MD040; edit the fenced block that currently contains "src/" (the
project structure code block) to use the text language identifier and ensure the
tree lines (like "src/" and the routes entry) remain inside the fence.
- Around line 13-34: Add blank lines before and after each Markdown heading in
this block to satisfy MD022: ensure there is an empty line above and below "##
Features" and each subsection heading "### 🌍 Interactive 3D Globe", "### 📊
Calculation Engine", "### ⚖️ Customizable Planet Weights", and "### 💾 Save &
Share" so headings are separated from surrounding paragraphs and list items.
Comment on lines
+13
to
+34
| ## Features | ||
|
|
||
| ## Testing | ||
| ### 🌍 Interactive 3D Globe | ||
| Visualize your personalized astrological map on an interactive 3D globe showing: | ||
| - **ACG Lines** (Astro*Carto*Graphy) — Where planets rise, set, culminate, and anti-culminate | ||
| - **Zenith Bands** — Horizontal latitude bands where planets pass directly overhead | ||
| - **Paran Points** — Locations where two planets are simultaneously angular | ||
|
|
||
| This project uses [Vitest](https://vitest.dev/) for testing. You can run the tests with: | ||
| ### 📊 Calculation Engine | ||
| - **Planetary Positions** — Precise ephemeris calculations using Swiss Ephemeris (SWISSEPH) + astronomia (VSOP87) | ||
| - **Essential Dignities** — Traditional dignity scoring for each planet | ||
| - **Out-of-Bounds Detection** — Identifies planets beyond the Sun's declination range (±23.44°) | ||
| - **City Ranking** — Scores 10,000+ cities worldwide based on your chart | ||
|
|
||
| ```bash | ||
| bun --bun run test | ||
| ``` | ||
| ### ⚖️ Customizable Planet Weights | ||
| Prioritize what matters to you: | ||
| - **Relationship Focus** — Boost Venus, Moon, Mars | ||
| - **Career Focus** — Emphasize Sun, Saturn, Jupiter | ||
| - **Creative Focus** — Highlight Neptune, Venus, Uranus | ||
| - **Spiritual Focus** — Weight Neptune, Pluto, Jupiter | ||
|
|
||
| ## Styling | ||
| ### 💾 Save & Share |
Contributor
There was a problem hiding this comment.
Add blank lines around headings to satisfy MD022.
Markdownlint flags missing blank lines around headings in this section. Please add a blank line before and after the headings for consistent rendering.
📝 Suggested fix
## Features
+
### 🌍 Interactive 3D Globe
+
Visualize your personalized astrological map on an interactive 3D globe showing:
@@
### 📊 Calculation Engine
+
- **Planetary Positions** — Precise ephemeris calculations using Swiss Ephemeris (SWISSEPH) + astronomia (VSOP87)
@@
### ⚖️ Customizable Planet Weights
+
Prioritize what matters to you:
@@
### 💾 Save & Share
+
- Save multiple charts to your dashboard🧰 Tools
🪛 markdownlint-cli2 (0.20.0)
[warning] 15-15: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 21-21: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 27-27: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 34-34: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
🤖 Prompt for AI Agents
In `@README.md` around lines 13 - 34, Add blank lines before and after each
Markdown heading in this block to satisfy MD022: ensure there is an empty line
above and below "## Features" and each subsection heading "### 🌍 Interactive 3D
Globe", "### 📊 Calculation Engine", "### ⚖️ Customizable Planet Weights", and
"### 💾 Save & Share" so headings are separated from surrounding paragraphs and
list items.
Comment on lines
+59
to
+61
| ## Getting Started | ||
|
|
||
| - Set the `VITE_CONVEX_URL` and `CONVEX_DEPLOYMENT` environment variables in your `.env.local`. (Or run `npx convex init` to set them automatically.) | ||
| - Run `npx convex dev` to start the Convex server. | ||
| ### Prerequisites |
Contributor
There was a problem hiding this comment.
Add blank lines around the “Prerequisites” heading (MD022).
Markdownlint reports missing blank lines surrounding this heading.
📝 Suggested fix
### Prerequisites
+
- [Bun](https://bun.sh) (v1.0+)
- [Convex account](https://convex.dev) (free tier available)🧰 Tools
🪛 markdownlint-cli2 (0.20.0)
[warning] 61-61: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
🤖 Prompt for AI Agents
In `@README.md` around lines 59 - 61, Add blank lines around the "###
Prerequisites" heading to satisfy MD022: insert a single blank line before the
"### Prerequisites" line (so there is a blank line between "## Getting Started"
and "### Prerequisites") and ensure a blank line follows the "### Prerequisites"
heading before the next paragraph or list content.
Comment on lines
+140
to
155
| ## The Science | ||
|
|
||
| const countStore = new Store(0) | ||
| ### Declination vs Longitude | ||
| Traditional astrology focuses on **zodiacal longitude** (what sign a planet is in). Declination adds the **second dimension**—how far north or south of the celestial equator. | ||
|
|
||
| const doubledStore = new Derived({ | ||
| fn: () => countStore.state * 2, | ||
| deps: [countStore], | ||
| }) | ||
| doubledStore.mount() | ||
| ### Types of Planetary Lines | ||
|
|
||
| function App() { | ||
| const count = useStore(countStore) | ||
| const doubledCount = useStore(doubledStore) | ||
| | Type | Description | | ||
| |------|-------------| | ||
| | **Zenith Bands** | Horizontal latitude bands where a planet can pass directly overhead | | ||
| | **ACG Lines** | Curved lines showing where planets are angular (ASC/DSC/MC/IC) | | ||
| | **Parans** | Latitudes where two planets are simultaneously angular | | ||
|
|
||
| return ( | ||
| <div> | ||
| <button onClick={() => countStore.setState((n) => n + 1)}>Increment - {count}</button> | ||
| <div>Doubled - {doubledCount}</div> | ||
| </div> | ||
| ) | ||
| } | ||
| ### Out of Bounds (OOB) | ||
| When a planet's declination exceeds ±23.44° (the Sun's maximum), it's "out of bounds." OOB planets often indicate exceptional abilities and don't correspond to any latitude where the Sun reaches zenith. | ||
|
|
Contributor
There was a problem hiding this comment.
Add blank lines around the “Declination vs Longitude” and “Out of Bounds” headings (MD022).
📝 Suggested fix
## The Science
+
### Declination vs Longitude
+
Traditional astrology focuses on **zodiacal longitude** (what sign a planet is in). Declination adds the **second dimension**—how far north or south of the celestial equator.
@@
### Out of Bounds (OOB)
+
When a planet's declination exceeds ±23.44° (the Sun's maximum), it's "out of bounds." OOB planets often indicate exceptional abilities and don't correspond to any latitude where the Sun reaches zenith.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| ## The Science | |
| const countStore = new Store(0) | |
| ### Declination vs Longitude | |
| Traditional astrology focuses on **zodiacal longitude** (what sign a planet is in). Declination adds the **second dimension**—how far north or south of the celestial equator. | |
| const doubledStore = new Derived({ | |
| fn: () => countStore.state * 2, | |
| deps: [countStore], | |
| }) | |
| doubledStore.mount() | |
| ### Types of Planetary Lines | |
| function App() { | |
| const count = useStore(countStore) | |
| const doubledCount = useStore(doubledStore) | |
| | Type | Description | | |
| |------|-------------| | |
| | **Zenith Bands** | Horizontal latitude bands where a planet can pass directly overhead | | |
| | **ACG Lines** | Curved lines showing where planets are angular (ASC/DSC/MC/IC) | | |
| | **Parans** | Latitudes where two planets are simultaneously angular | | |
| return ( | |
| <div> | |
| <button onClick={() => countStore.setState((n) => n + 1)}>Increment - {count}</button> | |
| <div>Doubled - {doubledCount}</div> | |
| </div> | |
| ) | |
| } | |
| ### Out of Bounds (OOB) | |
| When a planet's declination exceeds ±23.44° (the Sun's maximum), it's "out of bounds." OOB planets often indicate exceptional abilities and don't correspond to any latitude where the Sun reaches zenith. | |
| ## The Science | |
| ### Declination vs Longitude | |
| Traditional astrology focuses on **zodiacal longitude** (what sign a planet is in). Declination adds the **second dimension**—how far north or south of the celestial equator. | |
| ### Types of Planetary Lines | |
| | Type | Description | | |
| |------|-------------| | |
| | **Zenith Bands** | Horizontal latitude bands where a planet can pass directly overhead | | |
| | **ACG Lines** | Curved lines showing where planets are angular (ASC/DSC/MC/IC) | | |
| | **Parans** | Latitudes where two planets are simultaneously angular | | |
| ### Out of Bounds (OOB) | |
| When a planet's declination exceeds ±23.44° (the Sun's maximum), it's "out of bounds." OOB planets often indicate exceptional abilities and don't correspond to any latitude where the Sun reaches zenith. |
🧰 Tools
🪛 markdownlint-cli2 (0.20.0)
[warning] 142-142: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 153-153: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
🤖 Prompt for AI Agents
In `@README.md` around lines 140 - 155, Add blank lines before and after the
"Declination vs Longitude" and "Out of Bounds (OOB)" headings in README.md to
satisfy MD022; specifically ensure there is an empty line above the "###
Declination vs Longitude" header and an empty line below it (before the next
heading or paragraph), and likewise add an empty line above and below the "###
Out of Bounds (OOB)" header so both headings are separated by blank lines from
surrounding content.
- Rewrite README.md with full project overview, features, tech stack, getting started guide, and architecture documentation - Expand CLAUDE.md with architecture overview, calculation modules, key patterns, and development commands - Add landing page screenshot for README hero image Co-Authored-By: Claude Opus 4.5 <[email protected]>
keithce
force-pushed
the
docs/improve-readme-and-claude-md
branch
from
dd477c7 to
81bb8ca
Compare
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@README.md`:
- Around line 174-175: Replace the repo-relative link "[Why Page](/why)" in
README.md with the full production URL for the live app (e.g. change "[Why
Page](/why)" to "[Why Page](https://your-production-domain/why)"); ensure the
link text remains "Why Page" and update any other app-route links similarly to
use fully qualified URLs so readers are directed to the live site rather than a
repo-relative GitHub path.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Changes
Test plan
🤖 Generated with Claude Code
Summary by CodeRabbit