docs: redesign README in synapse style + use shared logo + document ingress mode#23
Merged
Conversation
…ntent Same treatment as gen0sec/mcp-server #39: - Replace images/logo.svg with the shared Gen0Sec brand logo (was a different 2,981-byte SVG; now byte-identical to gen0sec/synapse's). - Adopt the synapse README design: centered logo, two centered badge rows, --- dividers, tagline + "what it does", requirements blockquote, a modes comparison table, a mermaid architecture diagram, docs table, acknowledgements. - Correct content drift: the README only documented the config-sync controller and 4 flags, but main also ships the Ingress + Gateway API controller mode (--ingress-mode) with ~16 more flags. Both modes and the full, accurate flag set (extracted from main.go on main) are now documented.
Full arxignis -> gen0sec rebrand (synapse-operator scope): - env ARX_KEY -> GEN0SEC_API_KEY - Helm value synapse.synapse.arxignis.apiKey -> synapse.synapse.gen0sec.apiKey These were the only real arxignis references in the repo (introduced by this README); no Go code, CI, or other files reference arxignis.
images/logo.png was still the old ARXIGNIS flame/castle logo (identical to the old helm-charts copy). Regenerated it from the canonical Gen0Sec logo.svg at 1280px so no old-brand asset remains in the repo. README already references logo.svg; logo.png is now consistent.
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.
Same treatment as
gen0sec/mcp-server#39: adopt thegen0sec/synapseREADME design language, standardize on the shared brand logo, and fix content that had drifted from the code.Logo
images/logo.svgwas a different 2,981-byte SVG — not the Gen0Sec brand logo. Replaced with the shared logo (byte-identical togen0sec/synapse:images/logo.svg, 84,120 bytes), vendored in-repo and referenced relatively (same convention synapse uses).Design (from synapse)
Centered logo, two centered badge rows (License/Release/Downloads/Docs/Discord/X + Discord/Substack CTA),
---dividers, a punchy tagline + What it does bullets, requirements blockquote, a Modes comparison table, amermaidArchitecture diagram, a Documentation table, and a Thank you! section.Accuracy fixes (the old README was stale)
The README only described the config-sync controller and 4 flags.
mainalso ships a second mode — the Ingress + Gateway API controller (--ingress-mode: renders class-matched Ingresses/HTTPRoutes into Synapse'supstreams.yaml, projects TLS Secrets,SIGHUPhot-reload, status publishing, shared-status leader election,--render-onceinitContainer). This PR documents both modes and the full flag set (~20), all extracted frommain.goonmain.Docs-only + the logo asset; no Go code touched.
config/,SECURITY.md,LICENSE, and every flag/default were verified againstorigin/main.Note: kept this repo's existing
gen0sec.substack.comSubstack link (synapse's README usesarxignis.substack.com) — flag me if it should match synapse instead.