docs: documentation audit — add missing READMEs, update inventory, fix Tycho version reference#1170
Conversation
There was a problem hiding this comment.
Pull request overview
This PR performs a documentation audit to bring module-level documentation back in sync with the current repository structure: it adds missing module READMEs, rewrites DOCUMENTATION_INVENTORY.md to accurately reflect coverage, and updates a stale Tycho version reference in the root pom.xml.
Changes:
- Added new README files for several previously undocumented modules (mining, Maven plugin, AST bridge, JGit backend/server).
- Reworked
DOCUMENTATION_INVENTORY.mdto include newly added modules and track README/ARCHITECTURE/TODO completeness accurately. - Updated the Java-version error text in
pom.xmlto reference Tycho5.0.2instead of5.0.1.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| sandbox-maven-plugin/README.md | Documents Maven plugin goals/config/usage (needs a correction on default phase for apply). |
| sandbox-jgit-storage-hibernate/README.md | Adds overview and architecture notes for the Hibernate/Lucene indexing backend. |
| sandbox-jgit-server-webapp/README.md | Adds REST endpoint and Docker deployment documentation (needs clarification on admin endpoint wiring). |
| sandbox-ast-api-jdt/README.md | Documents the JDT → fluent AST bridge module and usage. |
| sandbox_mining_core/README.md | Documents mining core architecture, config, and related docs. |
| sandbox_mining_cli/README.md | Documents mining CLI usage, output layout, and build instructions. |
| pom.xml | Updates the Tycho version mention in the Java-version error message. |
| DOCUMENTATION_INVENTORY.md | Updates inventory structure, coverage status tables, and “Known Gaps”. |
| | `GET` | `/api/analytics/authors?repo=...` | Author commit statistics | | ||
| | `GET` | `/api/analytics/objects?repo=...` | Object type counts | | ||
| | `GET` | `/api/analytics/packs?repo=...` | Pack file statistics | | ||
| | `POST` | `/api/admin/reindex` | Trigger full re-indexing of all repositories | |
|
@copilot Consider Review comments |
Both issues are fixed in the latest commit:
|
f15aecf
into
copilot/documentation-audit-refactoring
DOCUMENTATION_INVENTORY.md(last updated 2026-01-11) claimed 100% coverage but ~15 modules added since then were entirely absent. Several modules also had no README at all.New README files
sandbox_mining_core/— AI-assisted commit analysis engine (architecture, config, usage)sandbox_mining_cli/— standalone CLI: flags, example invocations, output layoutsandbox-maven-plugin/— goals (apply,check,diff), POM snippetsandbox-ast-api-jdt/— JDT→fluent API type mapping tablesandbox-jgit-storage-hibernate/— Hibernate/Lucene indexing backendsandbox-jgit-server-webapp/— REST endpoint table, Docker deploymentDOCUMENTATION_INVENTORY.md
Rewritten to reflect current reality: modules split into Eclipse plugins, plain Maven modules, infrastructure, distribution, test, and feature sections; accurate ✅/❌ coverage per module; "Known Gaps" section listing modules that still lack ARCHITECTURE.md/TODO.md.
Previously untracked modules now included:
sandbox_css_cleanup,sandbox_int_to_enum,sandbox_use_general_type,sandbox_common_core,sandbox_test_commons,sandbox-ast-api,sandbox-ast-api-jdt,sandbox-benchmarks,sandbox-functional-converter-core,sandbox-jgit-*,sandbox-maven-plugin,sandbox_mining_*,sandbox_cleanup_cli_dist,sandbox_cleanup_docker.pom.xml
Fixed stale error-message comment:
Tycho 5.0.1→Tycho 5.0.2(matches<tycho-version>5.0.2</tycho-version>).