Skip to content

docs: add visual quick start and npm README - #3

Merged
alsd4git merged 3 commits into
mainfrom
docs/readme-presentation
Oct 29, 2026
Merged

alsd4git merged 3 commits into
mainfrom
docs/readme-presentation

Conversation

@alsd4git

Copy link
Copy Markdown
Owner

Why

  • Give Nginx Proxy Manager users a quick, safe first run in both README languages.
  • Explain the mTLS certificate lifecycle before the detailed setup steps.

How

  • Add a synthetic dry-run SVG, link it from the English and Italian READMEs, and make README.md a real English file for GitHub and npm.
  • Add a short npm landing README with installation, dry-run guidance, and links to the complete language guides.
  • Add a Mermaid overview of CA issuance, local key and bundle outputs, optional sharing, and revocation status checks to the mTLS README.

Tests

  • npm test: 23 passed.
  • npm pack --dry-run --json --ignore-scripts: includes README.md, both language guides, and the SVG.
  • shellcheck ./*.sh ./lib/*.sh ./tests/*.sh: passed.
  • ./tests/run.sh: passed with the repository's fake CA and temporary certificates.
  • STEP_CA_PASSWORD=test-only docker compose config --quiet: passed.

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 29, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-29T19:29:13.279576Z 02020ae PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chatgpt-codex-connector

Copy link
Copy Markdown

💡 Codex Review

[changelog](CHANGELOG.md) for configuration, certificates, access lists, and

P2 Badge Include the linked changelog in the package

When users read this README from the installed or packed package, the CHANGELOG.md link is broken: the files allowlist added in this commit includes the READMEs and assets but not CHANGELOG.md, and npm pack --dry-run --json confirms that the changelog is absent. Include it in the package or make this an absolute repository link.

AGENTS.md reference: AGENTS.md:L22-L22

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

@alsd4git
alsd4git merged commit 502172e into main Oct 29, 2026
4 checks passed
@alsd4git
alsd4git deleted the docs/readme-presentation branch October 29, 2026 21:35
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.

1 participant