Repository navigation
docs(readme): match drydock's README shape - #377
Merged
Merged
Conversation
The README is being slimmed to drydock's section set, so anything it held that the docs pages lacked moves here first: the optional mTLS and TLS 1.2+ note for standard mode, the edge controller-trust paragraph and correlated request/response ownership, the BIND_ADDRESS refusal clause, and the loopback port publishing in the auth and standalone examples.
Slim the body to Documentation, Quick Start, Why Portwing, Features, Feature Comparison, Roadmap and Star History, with drydock's centered section headings, footer order and ecosystem table. The reference material (authentication, connection modes, standalone mode, configuration, API and MCP, stability, credential options, release verification, security, audit logging) lives on the docs site and is linked from the Documentation table. Adds the CodesWhat logo pair under docs/assets, switches the license badge to the auto one, and drops the Ko-fi and Buy Me a Coffee badges. The release contract pinned three things to the old layout: the tag-bound cosign command, the star-history anchor, and the README docker run count. The cosign check now reads docs/content/docs/verification.mdx, the star-history check keys on the section's id, and the docker run count is 1.
…e server doesn't back The current-release note still carried the v0.9.21 text saying agent behavior was unchanged. v0.9.23 added the Origin and Host checks and the exec_start admission outcome. Portwing's TLS listener sets no client-certificate verification, and ROADMAP.md lists client-certificate authentication as post-v1, so standard mode has no optional mTLS to document.
The self-test bumped a VERSION= line in README.md to prove the stale-version guard fires. That command now lives on the docs verification page, so the mutation found nothing and the self-test exited 1 with no output. It now bumps the portwing_<version>_ asset name, which the README still carries and the same guard covers.
Portainer and Komodo release evidence were marked absent where the landscape says not evaluated. The Drydock version note overstated what edge mode needs, the review note gave one date for two reviews, and the update-tools table carried a metrics row nobody has checked upstream. Cells the sources don't state are now '?'.
scttbnsn
requested review from
ALARGECOMPANY and
biggest-littlest
as code owners
October 8, 2026 16:22
|
Warning Review limit reachedYou've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. Next included review available in 10 minutes. View limit detailsLimit details: You’ve used the included review currently available. Review configuration: ⚙️ Run configuration
⛔ Files ignored due to path filters (2)
📒 Files selected for processing (9)
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 |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This was referenced Oct 8, 2026
Merged
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
1 participant
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.
Brings the README to the same shape as drydock's. 1091 lines down to 539.
Corrections found on the way:
docs/content/docs/competitive-landscape.mdx. Anything the landscape doesn't state is?, not ❌.Test changes: the tag-bound cosign check now reads
docs/content/docs/verification.mdx, the star-history check keys on the heading id, the standard-mode bind test expects onedocker runin the README instead of four, and the stale-version self-test mutates an asset name because theVERSION=line left the README.Not checked yet: how the mermaid block, the nested
<details>and the dark-mode logo render on GitHub. I'll look at the branch view once this is up.