docs(auth0-nuxt): add CLAUDE.md/AGENTS.md agent-onboarding suite - #58
Draft
gyaneshgouraw-okta wants to merge 2 commits into
Draft
docs(auth0-nuxt): add CLAUDE.md/AGENTS.md agent-onboarding suite#58gyaneshgouraw-okta wants to merge 2 commits into
gyaneshgouraw-okta wants to merge 2 commits into
Conversation
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
📝 WalkthroughWalkthroughAdds ChangesAI Agent Guidance
Estimated code review effort: 2 (Simple) | ~10 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ 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 |
gyaneshgouraw-okta
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@CLAUDE.md`:
- Around line 128-135: Update the command documentation so every e2e-inclusive
test command clearly uses the e2e “Ask First” workflow: in CLAUDE.md lines
128-135, references/commands.md lines 7-14, and references/commands.md lines
23-27, add the warning to npm test or npm run test, or change the core command
guidance to use the unit-only test command.
- Around line 86-87: The documentation requirements are inconsistent between
CLAUDE.md and references/docs-update.md. Update CLAUDE.md’s public
API/configuration guidance and the corresponding table in
references/docs-update.md to use one authoritative mapped policy, explicitly
noting that both documents are consistent; cover CLAUDE.md lines 86-87 and
references/docs-update.md lines 21-25 without retaining conflicting blanket
requirements.
- Around line 36-63: Update the fenced repository tree in the CLAUDE.md
documentation to specify a language after the opening fence, using text or
another appropriate plain-text language identifier; leave the tree contents
unchanged.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: d2716114-33d8-4818-872d-c45f62329665
📒 Files selected for processing (8)
AGENTS.mdCLAUDE.mdreferences/code-style.mdreferences/commands.mdreferences/docs-update.mdreferences/git-workflow.mdreferences/pitfalls.mdreferences/testing.md
Comment on lines
+36
to
+63
| ``` | ||
| . | ||
| ├── packages/ | ||
| │ ├── auth0-nuxt/ # the published SDK (@auth0/auth0-nuxt) | ||
| │ │ ├── src/ | ||
| │ │ │ ├── module.ts # Nuxt module entry — registers routes, plugin, middleware | ||
| │ │ │ ├── types.ts # public types (Auth0ClientOptions, RouteConfig, SessionStore) | ||
| │ │ │ ├── types/ # ambient .d.ts (runtime-config, session-store) | ||
| │ │ │ └── runtime/ | ||
| │ │ │ ├── composables/ # client composables (use-user) | ||
| │ │ │ ├── middleware/ # global route middleware (auth.server) | ||
| │ │ │ ├── helpers/ # import-meta client/server guard | ||
| │ │ │ └── server/ | ||
| │ │ │ ├── api/auth/ # H3 handlers: login/callback/logout/backchannel-logout | ||
| │ │ │ ├── composables/ # useAuth0() server composable | ||
| │ │ │ ├── plugins/ # Nitro plugin — builds client, validates config | ||
| │ │ │ └── utils/ # cookie-handler, url (safe-redirect), session-store loader | ||
| │ │ ├── test/ # e2e (@nuxt/test-utils + Playwright) + fixtures | ||
| │ │ ├── EXAMPLES.md # advanced usage & configuration samples | ||
| │ │ └── README.md | ||
| │ └── lint-pr-title/ # internal GitHub composite action (not published) | ||
| ├── examples/ # runnable demo apps | ||
| │ ├── example-nuxt-web/ # Nuxt 3 web app demo | ||
| │ └── example-nuxt-4-web/ # Nuxt 4 web app demo | ||
| ├── docs/ # generated TypeDoc output — do not hand-edit | ||
| ├── turbo.json # Turborepo task graph | ||
| └── vitest.workspace.js | ||
| ``` |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Add a language to the fenced code block.
markdownlint reports MD040 for this repository tree fence. Use text (or another appropriate language) after the opening fence.
Proposed fix
-```
+```text📝 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
| ``` | |
| . | |
| ├── packages/ | |
| │ ├── auth0-nuxt/ # the published SDK (@auth0/auth0-nuxt) | |
| │ │ ├── src/ | |
| │ │ │ ├── module.ts # Nuxt module entry — registers routes, plugin, middleware | |
| │ │ │ ├── types.ts # public types (Auth0ClientOptions, RouteConfig, SessionStore) | |
| │ │ │ ├── types/ # ambient .d.ts (runtime-config, session-store) | |
| │ │ │ └── runtime/ | |
| │ │ │ ├── composables/ # client composables (use-user) | |
| │ │ │ ├── middleware/ # global route middleware (auth.server) | |
| │ │ │ ├── helpers/ # import-meta client/server guard | |
| │ │ │ └── server/ | |
| │ │ │ ├── api/auth/ # H3 handlers: login/callback/logout/backchannel-logout | |
| │ │ │ ├── composables/ # useAuth0() server composable | |
| │ │ │ ├── plugins/ # Nitro plugin — builds client, validates config | |
| │ │ │ └── utils/ # cookie-handler, url (safe-redirect), session-store loader | |
| │ │ ├── test/ # e2e (@nuxt/test-utils + Playwright) + fixtures | |
| │ │ ├── EXAMPLES.md # advanced usage & configuration samples | |
| │ │ └── README.md | |
| │ └── lint-pr-title/ # internal GitHub composite action (not published) | |
| ├── examples/ # runnable demo apps | |
| │ ├── example-nuxt-web/ # Nuxt 3 web app demo | |
| │ └── example-nuxt-4-web/ # Nuxt 4 web app demo | |
| ├── docs/ # generated TypeDoc output — do not hand-edit | |
| ├── turbo.json # Turborepo task graph | |
| └── vitest.workspace.js | |
| ``` |
🧰 Tools
🪛 markdownlint-cli2 (0.23.0)
[warning] 36-36: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@CLAUDE.md` around lines 36 - 63, Update the fenced repository tree in the
CLAUDE.md documentation to specify a language after the opening fence, using
text or another appropriate plain-text language identifier; leave the tree
contents unchanged.
Source: Linters/SAST tools
Comment on lines
+86
to
+87
| - Update `README.md` (both root and `packages/auth0-nuxt/README.md`) and `packages/auth0-nuxt/EXAMPLES.md` in the same PR when changing the public API (`ModuleOptions`, `Auth0ClientOptions`, `RouteConfig`), configuration options, or supported integration patterns. | ||
| - Update the affected apps under `examples/` in the same PR when changing the public API they demonstrate. |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟠 Major | ⚡ Quick win
Use one authoritative documentation-update matrix. The core guidance and reference table currently require different files for public API and configuration changes.
CLAUDE.md#L86-L87: replace the blanket “both root and package README” rule with the mapped requirements, or update the table to include both.references/docs-update.md#L21-L25: mirror the selected policy and make it explicit that it is consistent withCLAUDE.md.
📍 Affects 2 files
CLAUDE.md#L86-L87(this comment)references/docs-update.md#L21-L25
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@CLAUDE.md` around lines 86 - 87, The documentation requirements are
inconsistent between CLAUDE.md and references/docs-update.md. Update CLAUDE.md’s
public API/configuration guidance and the corresponding table in
references/docs-update.md to use one authoritative mapped policy, explicitly
noting that both documents are consistent; cover CLAUDE.md lines 86-87 and
references/docs-update.md lines 21-25 without retaining conflicting blanket
requirements.
Comment on lines
+128
to
+135
| ```bash | ||
| npm install # install all workspaces | ||
| npm run build # turbo run build → nuxt-module-build | ||
| npm test # turbo run test (unit + e2e per package) | ||
| npm run lint # turbo run lint → eslint | ||
| ``` | ||
|
|
||
| See [references/commands.md](references/commands.md) for the full command list (per-package unit/e2e/coverage, clean, docs, examples). Read when you need to build, test, or run something specific. |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Add consistent warnings to e2e-inclusive test commands. The core and reference command lists present npm test and package npm run test as routine commands even though they include credentialed e2e tests.
CLAUDE.md#L128-L135: marknpm testas requiring the e2e “Ask First” workflow, or make the core command unit-only.references/commands.md#L7-L14: add the same warning to rootnpm test.references/commands.md#L23-L27: add the warning to packagenpm run testor direct users totest:unit.
📍 Affects 2 files
CLAUDE.md#L128-L135(this comment)references/commands.md#L7-L14references/commands.md#L23-L27
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@CLAUDE.md` around lines 128 - 135, Update the command documentation so every
e2e-inclusive test command clearly uses the e2e “Ask First” workflow: in
CLAUDE.md lines 128-135, references/commands.md lines 7-14, and
references/commands.md lines 23-27, add the warning to npm test or npm run test,
or change the core command guidance to use the unit-only test command.
sanchitmehtagit
force-pushed
the
claude-md
branch
2 times, most recently
from
August 3, 2026 10:00
d5d6082 to
a9b69a6
Compare
Rebuild the agent-onboarding suite from the generating-claude-md skill template rather than editing the prior files: - Drop the Project Overview section (intentionally absent — language, stack, package manager, and platform all live in the authoritative manifest + CI, so restating them only drifts). - Drop the standalone Key Files table — the annotated Project Structure tree already flags every entry point inline, per the template. - Trim boundaries/security to the mistake-preventing essentials. - AGENTS.md reduced to the minimal template form importing @./CLAUDE.md. Reference offloads (references/*.md) validated against source and CI.
sanchitmehtagit
marked this pull request as draft
August 15, 2026 11:01
sanchitmehtagit
force-pushed
the
claude-md
branch
from
August 15, 2026 11:02
a9b69a6 to
3342378
Compare
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
2 participants
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
Adds an AI-agent onboarding suite for the
auth0-nuxtmonorepo so Claude Code and other agents get accurate, actionable context (commands, guardrails, conventions) instead of re-deriving it each session.CLAUDE.mdis the single source of truth,AGENTS.mdpoints to it, and reference-section bodies are lazily loaded fromreferences/*.md. Docs-only - no source, build, or CI behavior changes.Changes
NUXT_AUTH0_*secrets.@auth0/auth0-server-js) and documents that as a pitfall rather than inventing a boundary.auth0-nuxtscope andrelease/*branch flow.Testing
CLAUDE.mdfor accuracy of persona, boundaries, and security notes.Summary by CodeRabbit