Repository navigation
docs: prepare the tree for the public export (G3) - #75
Merged
Merged
Conversation
24 tasks
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
force-pushed
the
docs/g3-public-cleanup
branch
from
November 16, 2026 06:24
e9402bb to
1ceec3c
Compare
Contributor
Author
|
Merged into |
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
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.
What: Adds
.public-excludeand 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-excludelistsAGENTS.mdand 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.pypatterns, honouring.public-exclude): beforeclusters 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.mdis also changed by #74, #73, #71 and #70;docs/operations/service.mdby #74;Dockerfileby #73 (itsFROMlines). Small textual rebases.