Repository navigation
docs: add MIT licence and rewrite docs for public readers - #23
Merged
Merged
Conversation
Keeps the rewritten README, whose dev URL table is gone, and points its SEARCH_API_BASE note and docs/development.md at the apis proxy that dev's .env.example now uses.
jm-rivera
marked this pull request as ready for review
October 20, 2026 15:22
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.
Rewrites the README for public readers, adds a contributing guide and an MIT licence (copyright ONE Campaign), and moves maintainer guidance into
docs/development.md.The README explains the back ends needed for search, the Studio, and accounts.
CONTRIBUTING.mdcovers local setup, checks, migrations, branches, and the organisation policies. Pipeline conventions, releases, and deployed services live indocs/development.md, with the deploy and CI comments pointing there.Testing: Prettier passes on the changed Markdown and CI workflow. All 10 relative links and anchors resolve. The organisation policy links resolve, and
git diff --checkpasses. CI passes lint, CSS lint, typecheck, tests, the production build, and the migration bundle build and smoke test.