Repository navigation
rewrite public docs in plain voice - #16
Merged
Merged
Conversation
|
Deployment failed for project guardrail-agent with the following error: Learn More: https://vercel.com/o-mids-projects?upgradeToPro=build-rate-limit |
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
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.
Problem
The public docs still read like a template: even cadence, slogan closers, and a few not-X-but-Y reframes. An interviewer should hear a specific engineer, not a generated README.
Solution
Rewrite the existing public markdown in a plain engineer-to-engineer voice. Same facts (local Anvil/solana, hosted MockPlanner, fail-closed openai, vault Bearer token, demo login, reject codes). No new landing page.
How to test
Read README.md and the files under docs/ plus packages/evals/README.md. Confirm URLs, demo credentials, hostile paste, and reject codes are unchanged. Confirm the diff has no tooling attribution or generated-by lines.