Skip to content

docs: Add Architecture.md file#35

Merged
frederikprijck merged 5 commits into
mainfrom
doc/add_architecture.md
Jun 16, 2026
Merged

docs: Add Architecture.md file#35
frederikprijck merged 5 commits into
mainfrom
doc/add_architecture.md

Conversation

@sanchitmehtagit

Copy link
Copy Markdown
Contributor

By submitting a PR to this repository, you agree to the terms within the Auth0 Code of Conduct. Please see the contributing guidelines for how to create and submit a high-quality PR for this repo.

Description

Adding Architecture.md file

References

Include any links supporting this change such as a:

  • GitHub Issue/PR number addressed or fixed
  • Auth0 Community post
  • StackOverflow post
  • Support forum thread
  • Related pull requests/issues from other repos

If there are no references, simply delete this section.

Testing

Describe how this can be tested by reviewers. Be specific about anything not tested and reasons why. If this library has unit and/or integration testing, tests should be added for new functionality and existing tests should complete without errors.

Please include any manual steps for testing end-to-end or functionality not covered by unit/integration tests.

Also include details of the environment this PR was developed in (language/platform/browser version).

  • This change adds test coverage for new/changed/fixed functionality

Checklist

  • I have added documentation for new/changed functionality in this PR or in auth0.com/docs
  • All active GitHub checks for tests, formatting, and security are passing
  • The correct base branch is being used, if not the default branch

Comment thread docs/ARCHITECTURE.md Outdated
| `agent+mcp` | `--mode agent --tools mcp` | + Auth0 docs MCP | L1–L5 |
| `agent+mcp+skills` | `--mode agent --tools mcp,skills` | full investment | L1–L5 |

## How the leaderboard "lights up"

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lets remove leaderboard section for now

Comment thread docs/ARCHITECTURE.md Outdated
@@ -0,0 +1,172 @@
# Architecture

`auth0-evals` is a **TypeScript monorepo** (npm workspaces + Turbo) that runs LLM coding agents against Auth0 SDK integration tasks and scores the code they produce. It is the measurement half of a "docs flywheel": run a realistic integration task across multiple agents and documentation-investment levels, grade the generated code, and turn each score into a concrete fix for the docs, skills, or MCP server. The guiding belief — **every score must point to a fix**.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This needs an update

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated. Added description manually

@sanchitmehtagit sanchitmehtagit force-pushed the doc/add_architecture.md branch from 572f3fb to f51e47d Compare June 15, 2026 17:07
@sanchitmehtagit sanchitmehtagit force-pushed the doc/add_architecture.md branch from 79bfd29 to 03c5628 Compare June 16, 2026 14:09
@frederikprijck frederikprijck merged commit 0fa5e55 into main Jun 16, 2026
5 checks passed
@frederikprijck frederikprijck deleted the doc/add_architecture.md branch June 16, 2026 14:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants