Remove outdated documentation and add new references for Pushgate v2 …#67
Merged
Conversation
…configuration and changed-file policy - Deleted the obsolete `issue-3-hook-runner-test-harness-plan.md` and `product-contract-plan.md` documents. - Introduced `changed-file-policy.md` to define the contract for handling changed files in Pushgate. - Added `configuration.md` to outline the structure and defaults of the new `.pushgate.yml` configuration file. - Created `local-ai-review.md` to describe the local AI review process and its modes. - Removed the old `v2-config-schema.md` as its content has been integrated into the new configuration reference.
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.
This pull request introduces a comprehensive documentation overhaul for Pushgate, adding a maintained docs directory with architecture, domain, and reference material, as well as a set of Architecture Decision Records (ADRs). It also updates existing documentation to point to the new docs and clarifies terminology in the domain glossary. The changes improve the maintainability and clarity of Pushgate's documentation for both current and future contributors.
Major documentation additions:
docs/directory containing:docs/README.md) that links to domain model, glossary, architecture overview, runtime flow, module map, ADRs, and reference contracts.Improvements to existing documentation:
README.mdto reference the new docs index and configuration reference, streamlining and clarifying configuration documentation. [1] [2]AGENTS.mdclarifying documentation practices for TSDoc, inline comments, and the use of thedocs/directory.Domain language and glossary updates:
CONTEXT.md, including "Review Output Contract" and "Warning Confirmation," to standardize Pushgate's domain vocabulary. [1] [2]These changes lay a strong foundation for ongoing documentation quality and help ensure that architectural decisions, terminology, and reference material are consistently maintained.