docs: add file organization conventions - #249
Open
angeloashmore wants to merge 2 commits into
Open
Conversation
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Remove the env import from the docs client by hardcoding the docs host with an override option, and replace completeOnboardingStepsSilently with an inline catch at its call sites. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
angeloashmore
marked this pull request as ready for review
July 31, 2026 19:48
This was referenced Jul 31, 2026
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.
Resolves:
Description
Writes down the repository's file organization conventions in a new
AGENTS.mdso agents and developers can follow them, and aligns existing code with those conventions:envobject; it hardcodes the docs host with an override option, and callers passPRISMIC_DOCS_HOSTthrough.completeOnboardingStepsSilentlyis removed from the repository client; callers use an inline.catch()instead.Checklist
Preview
How to QA 1
Run
node --run build, then./dist/index.mjs docs listto confirm the docs commands still reach the live docs host.🤖 Generated with Claude Code
Footnotes
Please use these labels when submitting a review:
⚠️ #issue: Strongly suggest a change.
❓ #ask: Ask a question.
💡 #idea: Suggest an idea.
🎉 #nice: Share a compliment. ↩