Skip to content

chore: docs sync (fixes #168)#206

Open
mirkosalvato1-ctrl wants to merge 1 commit into
alphacrack:mainfrom
mirkosalvato1-ctrl:oslifeguard/docs_sync-168-1784713300
Open

chore: docs sync (fixes #168)#206
mirkosalvato1-ctrl wants to merge 1 commit into
alphacrack:mainfrom
mirkosalvato1-ctrl:oslifeguard/docs_sync-168-1784713300

Conversation

@mirkosalvato1-ctrl

Copy link
Copy Markdown

Proactive maintenance PR from OSS Lifeguard.

readme_env_setup:README.md

Happy to adjust if maintainers prefer a different approach.

Fixes #168

@alphacrack alphacrack left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

Thanks for the interest, but I'd recommend closing this one — there are four problems, and the first is the serious one.

1. The Fixes #168 link is wrong, and merging would destroy tracked work. #168 is "restructure SECURITY.md's sandbox section into a claims-vs-roadmap table" — a security-documentation issue that has nothing to do with README env setup. Merging this PR would auto-close it. #168 is also actively being worked in #205, which is a real implementation of it. An automated Related: #168 at confidence: 0.59 is not a strong enough basis for a Fixes: link.

2. The content is already documented, better, further up. README.md:36-51 covers auth setup in detail — all four options, with the actual export CLAUDE_CODE_OAUTH_TOKEN=... / export ANTHROPIC_API_KEY=... lines — and docs/configuration.md:27 already points at .env.example. This adds a second, thinner setup section that contradicts nothing but duplicates everything.

3. The placement is backwards. The new ## Setup section is appended after the Contributors section, at the very bottom of the file. Setup instructions below the contributor mosaic won't be found by the people who need them.

4. cp .env.example .env alone doesn't do anything here. There's no python-dotenv dependency and nothing in src/readme2demo/ loads a .env file — the tool reads real environment variables, which is why the README says export .... So a reader who follows this instruction copies a file and is no closer to a working setup. That matters more than usual in this repo: readme2demo exists to stop READMEs from shipping instructions that don't actually work, so a quickstart step that leads nowhere is the one bug we can't ship.

If you'd like to contribute something in this area, the genuinely open, well-scoped version is #202 (a "Run did not verify" issue template) or #199 (the examples gallery index) — both are labeled good first issue with the specific files and acceptance criteria spelled out.

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.

docs: restructure SECURITY.md's sandbox section into a claims-vs-roadmap table (supersedes #65)

2 participants