Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughAdded two documentation files under docs/content/4.integrations: a navigation YAML Suggested reviewers
🚥 Pre-merge checks | ❌ 1❌ Failed checks (1 inconclusive)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 4
♻️ Duplicate comments (2)
docs/content/4.integrations/1.atmosphere.md (2)
69-71:⚠️ Potential issue | 🟡 MinorUnresolved grammar issues and non-descriptive link from previous review cycle.
Three issues flagged in the prior review remain unfixed:
- Line 69:
"If you're wanting to migrate"— use present tense:"If you want to migrate".- Line 69:
"support migrating then please"— insert a comma:"support migrating, please".- Line 71: Link text
[here]is non-descriptive (MD059); suggested replacement:[official ATProto PDS guide].
83-85:⚠️ Potential issue | 🟡 MinorCopy-pasted Architecture intro still used verbatim in "How & Why" section.
Line 85 —
"These are the components that allow for _npmx.dev_ to exist as an app on the Atmosphere:"— is the Architecture section's opening sentence, not an appropriate intro for the "How & Why" section. This was flagged in the prior review and remains unchanged.✏️ Proposed fix
-These are the components that allow for _npmx.dev_ to exist as an app on the Atmosphere: +The Atmosphere integration serves several goals for _npmx.dev_:
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (4)
docs/content/4.integrations/1.atmosphere.md (4)
10-10:⚠️ Potential issue | 🟡 MinorOverview sentence is still a fragment — missing a main verb.
The line remains a noun phrase with no predicate.
✏️ Proposed fix
-_npmx.dev_ site architecture as it pertains to the ATProtocol (ATProto) ecosystem, the [Atmosphere](https://atproto.com/). +This page describes the _npmx.dev_ site architecture as it pertains to the ATProtocol (ATProto) ecosystem, known as the [Atmosphere](https://atproto.com/).
34-34:⚠️ Potential issue | 🟡 MinorNon-descriptive
[here]link text — still unresolved across five locations.Lines 34, 40, 48, 60, and 70 all use
[here]as link text, violating MD059.✏️ Proposed fixes
-For more details refer to the official ATProto docs [here](https://atproto.com/guides/the-at-stack). +For more details refer to the [official ATProto stack overview](https://atproto.com/guides/the-at-stack). -For more details refer to the official ATProto docs [here](https://atproto.com/guides/the-at-stack#app-views). +For more details refer to the [official ATProto App View guide](https://atproto.com/guides/the-at-stack#app-views). -For more details refer to the official ATProto docs [here](https://atproto.com/specs/oauth). +For more details refer to the [official ATProto OAuth spec](https://atproto.com/specs/oauth). -For more details refer to the official ATProto docs [here](https://atproto.com/specs/lexicon). +For more details refer to the [official ATProto Lexicon spec](https://atproto.com/specs/lexicon). -For more details refer to the official ATProto docs [here](https://atproto.com/guides/the-at-stack#pds). +For more details refer to the [official ATProto PDS guide](https://atproto.com/guides/the-at-stack#pds).Also applies to: 40-40, 48-48, 60-60, 70-70
68-68:⚠️ Potential issue | 🟡 MinorGrammar issues in PDS migration sentence — still unresolved.
Two issues remain: (1)
"If you're wanting to migrate"should use simple present —"If you want to migrate"; (2) missing comma —"support migrating, then please join".✏️ Proposed fix
-If you're wanting to migrate to _npmx.dev_'s self-hosted PDS then the primary means is to leverage [PDS MOOver](https://pdsmoover.com/moover/npmx.social), made by the community's own <a href="https://bsky.app/profile/baileytownsend.dev" target="_blank" rel="noopener noreferrer">@baileytownsend.dev</a>. If you need further support migrating then please join the community [Discord](https://chat.npmx.dev) and refer to the `#pds` channel. +If you want to migrate to _npmx.dev_'s self-hosted PDS, the primary means is to leverage [PDS MOOver](https://pdsmoover.com/moover/npmx.social), made by the community's own <a href="https://bsky.app/profile/baileytownsend.dev" target="_blank" rel="noopener noreferrer">@baileytownsend.dev</a>. If you need further support migrating, please join the community [Discord](https://chat.npmx.dev) and refer to the `#pds` channel.
82-89:⚠️ Potential issue | 🟡 Minor"How & Why" section still uses the copy-pasted Architecture intro sentence.
"These are the components that allow for _npmx.dev_ to exist as an app on the Atmosphere:"does not describe what follows (use-cases, not components).✏️ Proposed fix
-These are the components that allow for _npmx.dev_ to exist as an app on the Atmosphere: +The Atmosphere integration serves the following goals for _npmx.dev_:
|
|
||
| These are the essential components that allow for _npmx.dev_ to exist as an app on the Atmosphere: | ||
|
|
||
| 1. **App View** - _npmx.dev_ site |
There was a problem hiding this comment.
We don't technically have an AppView right now. More so rely on constellation to aggregate that information for us currently. An AppView be like if we had a firestream listener and saving that info internally for view
There was a problem hiding this comment.
+1, npmx would just be the frontend, a clearer name would be "Client" or "Browser"
There was a problem hiding this comment.
Would "Domain" be satisfactory? My resistance to using "Client" or "Browser" is that I think they're incredibly vague and slightly misleading, respectively.
|
|
||
| These are the essential components that allow for _npmx.dev_ to exist as an app on the Atmosphere: | ||
|
|
||
| 1. **App View** - _npmx.dev_ site |
There was a problem hiding this comment.
+1, npmx would just be the frontend, a clearer name would be "Client" or "Browser"
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (5)
docs/content/4.integrations/1.atmosphere.md (5)
10-10: Overview sentence is still a fragment.The sentence remains without a main predicate verb — this was previously raised and discussed.
72-72: Grammar issues on Line 72 are still unresolved.Two previously flagged items remain:
"If you're wanting to migrate"→"If you want to migrate"(unnatural progressive form)."support migrating then please"→"support migrating, please"(missing comma).
90-90: Copy-pasted intro sentence in "How & Why" is still present.Line 90 is a near-verbatim copy of the Architecture intro (Line 24) and is contextually inaccurate for a section about motivations, not components. This was flagged previously.
104-104:readme.mdlink text still points to a directory tree view, not a file.The URL resolves to the
constellation/directory on GitHub — the link textreadme.mdis misleading. This was flagged in the previous review.
34-34:⚠️ Potential issue | 🟡 MinorNon-descriptive
[here]link text and missing commas in repeated phrase.All seven "For more details refer to…" lines still carry
[here]as link text (MD059), and each is also missing a comma after the introductory phrase:"For more details, refer to…". The commas are a new static-analysis finding; the link-text issue was flagged previously.Also applies to: 40-40, 48-48, 54-54, 64-64, 74-74, 80-80
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (5)
docs/content/4.integrations/1.atmosphere.md (5)
10-10:⚠️ Potential issue | 🟡 MinorOverview sentence is still a fragment.
The sentence has no main predicate verb — "as it pertains to" is a subordinate clause, leaving the subject "site architecture" without a verb.
✏️ Proposed fix
-_npmx.dev_ site architecture as it pertains to the ATProtocol (ATProto) ecosystem, the [Atmosphere](https://atproto.com/). +This page describes the _npmx.dev_ site architecture as it pertains to the ATProtocol (ATProto) ecosystem, the [Atmosphere](https://atproto.com/).
34-34:⚠️ Potential issue | 🟡 MinorNon-descriptive
[here]link text across all eight "For more details" lines (MD059).All eight "For more details … [here]" lines still use
[here]as link text, which violates MD059 and provides no context when links are traversed out of order (e.g. from a screen reader or search index).✏️ Proposed fixes
-For more details refer to the official ATProto docs [here](https://atproto.com/guides/the-at-stack). +For more details refer to the [official ATProto stack overview](https://atproto.com/guides/the-at-stack). -For more details refer to the official ATProto docs [here](https://atproto.com/guides/the-at-stack#app-views). +For more details refer to the [official ATProto App View guide](https://atproto.com/guides/the-at-stack#app-views). -For more details refer to the official ATProto docs [here](https://atproto.com/specs/oauth). +For more details refer to the [official ATProto OAuth spec](https://atproto.com/specs/oauth). -For more details refer to the official Constellation site [here](https://constellation.microcosm.blue/). +For more details refer to the [official Constellation site](https://constellation.microcosm.blue/). -...you can see them in the repo [here](https://github.com/npmx-dev/npmx.dev/tree/main/lexicons)... +...you can see them in the [npmx.dev lexicons directory](https://github.com/npmx-dev/npmx.dev/tree/main/lexicons)... -For more details refer to the official ATProto docs [here](https://atproto.com/specs/lexicon). +For more details refer to the [official ATProto Lexicon spec](https://atproto.com/specs/lexicon). -For more details refer to the official ATProto docs [here](https://atproto.com/guides/the-at-stack#pds). +For more details refer to the [official ATProto PDS guide](https://atproto.com/guides/the-at-stack#pds). -For more details refer to the official Standard Site [here](https://standard.site). +For more details refer to the [official Standard Site](https://standard.site).Also applies to: 40-40, 48-48, 54-54, 62-62, 64-64, 74-74, 80-80
72-72:⚠️ Potential issue | 🟡 MinorPDS migration sentence: progressive tense and missing comma still unaddressed.
Two grammar issues remain: "If you're wanting to migrate" (progressive where present tense is idiomatic) and "support migrating then please" (comma missing before
then).✏️ Proposed fix
-If you're wanting to migrate to _npmx.dev_'s self-hosted PDS then the primary means is to leverage [PDS MOOver](https://pdsmoover.com/moover/npmx.social), made by the community's own <a href="https://bsky.app/profile/baileytownsend.dev" target="_blank" rel="noopener noreferrer">@baileytownsend.dev</a>. If you need further support migrating then please join the community [Discord](https://chat.npmx.dev) and refer to the `#pds` channel. +If you want to migrate to _npmx.dev_'s self-hosted PDS, the primary means is to leverage [PDS MOOver](https://pdsmoover.com/moover/npmx.social), made by the community's own <a href="https://bsky.app/profile/baileytownsend.dev" target="_blank" rel="noopener noreferrer">@baileytownsend.dev</a>. If you need further support migrating, please join the community [Discord](https://chat.npmx.dev) and refer to the `#pds` channel.
90-90:⚠️ Potential issue | 🟡 Minor"How & Why" intro is still the architecture section's copy-pasted text.
"These are the components that allow for npmx.dev to exist as an app on the Atmosphere:" describes architecture, not motivation. The Resources section (line 101) was corrected in this revision but this one was missed.
✏️ Proposed fix
-These are the components that allow for _npmx.dev_ to exist as an app on the Atmosphere: +The Atmosphere integration serves several goals for _npmx.dev_:
104-104:⚠️ Potential issue | 🟡 Minor
readme.mdlink text still mismatches its target URL.The URL resolves to the GitHub directory tree, not a README file. The link text is therefore misleading.
✏️ Proposed fix
-- **Constellation Repo** - [readme.md](https://github.com/at-microcosm/microcosm-rs/tree/main/constellation) +- **Constellation Repo** - [GitHub repository](https://github.com/at-microcosm/microcosm-rs/tree/main/constellation)
|
|
||
| ### OAuth | ||
|
|
||
| Access to any ATProto affiliated entity requires an authenticated web presence which is achieved through OAuth verification. OAuth is strictly necessary to ensure user identities are securely authenticated against their respective PDS without exposing credentials to _npmx.dev_ directly. |
There was a problem hiding this comment.
Missing comma before non-restrictive which.
"web presence which is achieved" → "web presence, which is achieved" — the which clause is non-restrictive and should be set off by a comma.
✏️ Proposed fix
-Access to any ATProto affiliated entity requires an authenticated web presence which is achieved through OAuth verification.
+Access to any ATProto affiliated entity requires an authenticated web presence, which is achieved through OAuth verification.📝 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.
| Access to any ATProto affiliated entity requires an authenticated web presence which is achieved through OAuth verification. OAuth is strictly necessary to ensure user identities are securely authenticated against their respective PDS without exposing credentials to _npmx.dev_ directly. | |
| Access to any ATProto affiliated entity requires an authenticated web presence, which is achieved through OAuth verification. OAuth is strictly necessary to ensure user identities are securely authenticated against their respective PDS without exposing credentials to _npmx.dev_ directly. |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~44-~44: Possible missing comma found.
Context: ...ed entity requires an authenticated web presence which is achieved through OAuth verific...
(AI_HYDRA_LEO_MISSING_COMMA)
Current State