Skip to content

Beautify the README; fix health endpoint OpenAPI auth - #255

Merged
martsokha merged 2 commits into
mainfrom
docs/beautify-readme
Aug 30, 2026
Merged

Beautify the README; fix health endpoint OpenAPI auth#255
martsokha merged 2 commits into
mainfrom
docs/beautify-readme

Conversation

@martsokha

@martsokha martsokha commented Aug 30, 2026

Copy link
Copy Markdown
Member

Two changes:

1. Beautify the README

Restyles the README to match the Nvisy Studio README:

  • A centered hero — the shared brand logo, a bold tagline, a Build / Release / Security / License badge row (pointed at this repo's actual workflows), and a nvisy.com · docs.nvisy.com · app.nvisy.com link row.
  • The active-development warning callout, then consistent sections: Features, Requirements, Quick start, Commands (real Makefile targets), Documentation (the four docs/ files), Contributing, License, Support.

Adds the shared brand logo at .github/assets/logo.png (byte-identical to Studio's). Every linked path resolves to a file that exists.

The hero image and workflow badges render on GitHub, not in a local Markdown preview.

2. Fix the health endpoint's OpenAPI auth requirement

/health/ is mounted on the public router and accepts unauthenticated requests (an authenticated caller gets a real-time health check; an unauthenticated one gets the cached status). But because the handler extracted Option<AuthState>, aide's blanket Option<T> OperationInput delegated to AuthState's impl and stamped a required Bearer requirement — so the spec wrongly marked the endpoint auth-required, which misled SDK clients.

Adds an OptionalAuth extractor (its own file) that carries the same optional value but declares the token as optional in the spec — an empty security requirement (no auth) alongside the Bearer one. The health handler uses it; a unit test asserts the emitted security offers the unauthenticated alternative.

🤖 Generated with Claude Code

Restyle the README to match the Nvisy Studio README: a centered hero (shared
logo, tagline, and a Build/Release/Security/License badge row plus a site link
row), the active-development warning, and consistent sections — Features,
Requirements, Quick start, Commands, Documentation, Contributing, License, and
Support. Add the shared brand logo under .github/assets/. Every linked path
resolves to a file that exists.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_018bKk1YEG4tZ69jzYVQvQL8
@martsokha martsokha added the docs improvements, updates or additions to docs label Aug 30, 2026
@coderabbitai

coderabbitai Bot commented Aug 30, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: d867c796-6fc2-4b66-b3f4-73b3935561e0

📥 Commits

Reviewing files that changed from the base of the PR and between 06e5d93 and eef1cb8.

⛔ Files ignored due to path filters (1)
  • .github/assets/logo.png is excluded by !**/*.png
📒 Files selected for processing (1)
  • README.md

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The README was rewritten with a new project header, redaction pipeline overview, expanded feature list, setup requirements, command reference, documentation links, contribution guidance, and revised support links.

Changes

README refresh

Layer / File(s) Summary
Project overview and redaction pipeline
README.md
The README adds branding, project links, redaction pipeline details, and features for multimodal detection, review, workspace isolation, collaboration, and interactive documentation.
Setup and project reference
README.md
The README adds requirements, quick-start commands, a command table, individual documentation links, contribution guidance, and updated support links.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Merge Risk: ⚪ Minimal · up to eef1c

This PR refreshes the README and adds branding without changing application behavior, dependencies, permissions, or deployment. No actionable merge-blocking risk remains after normal checks and review.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Title check ⚠️ Warning The title accurately mentions the README change but also claims a health endpoint OpenAPI authentication fix that is not present in the changeset or objectives. Remove the unrelated health endpoint claim. Use a title such as "Beautify the README" or "Restyle the README with standardized sections and branding".
✅ Passed checks (4 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

  • Fix all pre-merge checks with AI
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/beautify-readme

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

The health handler extracts Option<AuthState> (it runs a real-time check for an
authenticated caller and returns the cached status otherwise), but aide's blanket
Option<T> OperationInput delegates to AuthState's impl, which stamps a required
Bearer requirement. The spec therefore marked /health/ as auth-required even
though it is mounted on the public router and accepts unauthenticated requests,
which misled SDK clients.

Add an OptionalAuth extractor (its own file) that carries the same optional value
but declares the token as optional in the spec — an empty security requirement
(no auth) alongside the Bearer one. Use it in the health handler. A unit test
asserts the emitted security offers the unauthenticated alternative.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_018bKk1YEG4tZ69jzYVQvQL8
@martsokha martsokha changed the title Beautify the README with a centered hero Beautify the README; fix health endpoint OpenAPI auth Aug 30, 2026
@martsokha martsokha added bug something isn't working as intended server API handlers, middleware, auth labels Aug 30, 2026
@martsokha martsokha self-assigned this Aug 30, 2026
@martsokha
martsokha merged commit 63424c8 into main Aug 30, 2026
9 checks passed
@martsokha
martsokha deleted the docs/beautify-readme branch August 30, 2026 13:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug something isn't working as intended docs improvements, updates or additions to docs server API handlers, middleware, auth

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant