Skip to content

docs: prepare the tree for the public export (G3) - #75

Merged
homer6 merged 3 commits into
devfrom
docs/g3-public-cleanup
Nov 16, 2026
Merged

homer6 merged 3 commits into
devfrom
docs/g3-public-cleanup

Conversation

@homer6

@homer6 homer6 commented Nov 15, 2026 •

Copy link
Copy Markdown
Contributor

What: Adds .public-exclude and removes internal material from the files that will be published: issue and pull request links, security finding ids, cluster, set and environment names, a production App's hostname, a quoted instruction, and "private" wording about this repository and its image.
Why: Gate G3 of the open-source release (https://github.com/oramasearch/orama-bridge/issues/275): nothing internal in any public tree. Under D-H the public repo starts from one scrubbed export commit of dev; issues and pull requests are not published.
How: .public-exclude lists AGENTS.md and the agent folders. Issue links become plain text, "Where it runs" says every Lake takes the operator default, the v0.2.2 note describes the bug without naming whose App showed it, the v0.2.1 and v0.2.4 notes state the release decisions without quoting anyone, and the image is described as published.

Update: the agent files (CLAUDE.md, AGENTS.md) now ship with the public repo, rewritten to be public, and .public-exclude (which listed only them) is removed; the Orama-internal rules moved to the private umbrella bridge, docs/agents/agent-application.md.

Changes

  • .public-exclude: new.
  • README.md, docs/operations/service.md, Dockerfile (header comment only): "private" wording about the repo and image. The App-facing "private repository" text (Apps' own source repos) is product behaviour and stays.
  • docs/releases/*.md: links, security finding ids, cluster/set/environment names, the App hostname, the quotes.

Proof

G3 scan (g3-scan.py patterns, honouring .public-exclude): before clusters 3, hosts 1, private-refs 6, agent-files 1; after, every column zero.

Tests not run: per Steve, 2026-11-14, tests run at review and release time. Only documentation and one comment change.

Likely conflicts

README.md is also changed by #74, #73, #71 and #70; docs/operations/service.md by #74; Dockerfile by #73 (its FROM lines). Small textual rebases.

Add .public-exclude (AGENTS.md and agent folders stay private) and take
internal material out of the files that will be published: issue and
pull request links, security finding ids, cluster, set and environment
names, the hostname of the App that prompted the v0.2.2 fix, a quoted
and a paraphrased instruction, and "private repository and image"
wording.
CLAUDE.md and AGENTS.md are no longer kept out of the public export: .public-exclude listed only them, so it is removed. The agent files are rewritten to be public (build and test commands, conventions, the architecture rules); the Orama-internal rules moved to the private umbrella bridge.
@homer6
homer6 force-pushed the docs/g3-public-cleanup branch from e9402bb to 1ceec3c Compare November 16, 2026 06:24
@homer6
homer6 merged commit c9cc363 into dev Nov 16, 2026
@homer6
homer6 deleted the docs/g3-public-cleanup branch November 16, 2026 06:24
@homer6

homer6 commented Nov 16, 2026

Copy link
Copy Markdown
Contributor Author

Merged into dev as a merge commit (c9cc363b) on Steve's review (2026-11-15). Low risk, on Steve's 2026-11-15 instruction to merge the low-risk PRs. Rebased onto dev; conflicts in (SBOM Dockerfile regenerated) were both-sides additions and keep both (Python compiles, TOML and JSON parse). Not built or tested in review (tests run at the release cut).

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