Merged
Conversation
- Remove leftover stubs at old locations (ADR/, Agents/, docs/dev-setup.md, docs/integration-testing.md) - Remove empty placeholder directories (docs/api/, docs/operations/) - Merge behavioral guardrails from claude.md into agents.md (single source of truth) - Move .github/prompts/ to docs/prompts/
- Rename VERSION to version.txt for clarity - Bump version from 0.0.3 to 0.0.4 - Update Makefile and Dockerfile references - Add version bump reminder to agents.md
Collaborator
Author
|
@copilot make sure all of the references in all documentation are correct |
7 tasks
There was a problem hiding this comment.
Pull request overview
This PR consolidates the project's documentation structure by organizing all documentation under docs/ with clear subdirectories for architecture, development, operations, and API references. The changes also rename the version file from VERSION to version.txt for consistency.
Changes:
- Consolidated documentation under
docs/witharchitecture/ADR/,development/, andprompts/subdirectories - Renamed version file from
VERSIONtoversion.txtwith updates to Makefile and Dockerfile - Added comprehensive documentation for integration testing and development setup
Reviewed changes
Copilot reviewed 10 out of 13 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| version.txt | New version file (0.0.4) replacing the old VERSION file |
| docs/development/integration-testing.md | New comprehensive guide for running integration tests against Samba AD |
| docs/development/dev-setup.md | New development setup guide with quick-start instructions and environment variables |
| docs/development/agents.md | Agent workflow documentation moved from Agents/ with added ground rules and existing docs index |
| docs/architecture/ADR/2025-12-22_consolidate_documentation_structure.md | ADR documenting the documentation consolidation decision |
| docs/architecture/ADR/2025-12-18_middleware_design_pattern.md | ADR for middleware design pattern (moved from root ADR/) |
| docs/architecture/ADR/0000_template.md | Template for future ADRs with standardized format |
| VERSION | Removed in favor of version.txt |
| README.md | Updated to reflect new documentation structure under docs/ |
| Makefile | Updated version, bump-version, and release targets to use version.txt |
| Dockerfile | Updated build ldflags to read from version.txt |
| CHANGELOG.md | Added entry for version 0.0.4 documenting the consolidation changes |
Comments suppressed due to low confidence (1)
docs/development/agents.md:57
- Multiple lines are concatenated without proper line breaks. The text "- Prefer minimal changes; don't modify DNS forwarder or healthchecks unless necessary.- When releasing, bump
version.txtand updateCHANGELOG.md. Usemake bump-version VERSION=x.y.zor edit directly.- Refer to the integration test workflow if necessary: Integration Testing" should be split into separate lines with proper formatting.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
docs/architecture/ADR/2025-12-22_consolidate_documentation_structure.md
Outdated
Show resolved
Hide resolved
docs/architecture/ADR/2025-12-22_consolidate_documentation_structure.md
Outdated
Show resolved
Hide resolved
- Replace planned directory tree with actual implemented structure - Prompts at docs/prompts/, not root prompts/ - Remove empty placeholder directories (api/, operations/) - Fix broken link to non-existent prompts file
Collaborator
Author
|
@copilot double check to make sure there are no issues. Please do not create another branch and pull request. Just review. |
Contributor
* Initial plan * docs: fix README project layout to match actual structure Co-authored-by: operatr <96798445+operatr@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: operatr <96798445+operatr@users.noreply.github.com>
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.
No description provided.