-
Notifications
You must be signed in to change notification settings - Fork 0
Jrepp - Cleanup Docs Build Output #189
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Removed 1,307 committed build output files from docs/ directory: - All HTML files (ADRs, RFCs, MEMOs, user guide pages) - All JavaScript bundles and assets (70,681 lines) - All CSS files - All JSON and XML files (search index, sitemap) Preserved important non-generated assets: - docs/img/ directory with 13 image files: - Prism logos (PNG, SVG) - Favicon and icons - Docusaurus default images - Social card image Added docs/.gitignore to prevent future build output commits: - Ignores *.html (all generated pages) - Ignores specific generated directories (/adr/, /rfc/, /memos/, /user-guide/, etc.) - Ignores /assets/css/ and /assets/js/ (generated bundles) - Ignores search-index.json and sitemap.xml - Explicitly allows /img/ directory and all images Remaining tracked files in docs/: - docs/.nojekyll (required by GitHub Pages) - docs/.gitignore (newly added) - docs/img/ (13 image files preserved) Build output will be generated by CI via "docusaurus build --out-dir ../docs" and published to GitHub Pages automatically. Source documentation remains in docusaurus/docs/ and docs-cms/.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR removes generated documentation build output from the docs/ directory and establishes a .gitignore to prevent future commits of build artifacts. The changes ensure only source files and necessary GitHub Pages configuration are tracked, while all HTML, CSS, and JavaScript output is properly excluded.
Key Changes:
- Removed all generated HTML documentation files from
docs/adr/directory - Added comprehensive
.gitignoreindocs/directory to exclude build output - Preserves tracked assets like images in
docs/img/directory
Reviewed Changes
Copilot reviewed 17 out of 1307 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/adr/adr-013/index.html | Removed generated HTML for Go Error Handling Strategy ADR |
| docs/adr/adr-015/index.html | Removed generated HTML for Go Testing Strategy ADR |
| docs/adr/adr-016/index.html | Removed generated HTML for Go CLI Configuration ADR |
| docs/adr/adr-017/index.html | Removed generated HTML for Go Structured Logging ADR |
| docs/adr/adr-018/index.html | Removed generated HTML for Rust Error Handling Strategy ADR |
| docs/.gitignore | Added gitignore rules to exclude all build output while preserving source assets |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
This PR is very large (XL). Consider breaking it into smaller, more reviewable PRs. |
Codecov Report✅ All modified and coverable lines are covered by tests.
Additional details and impacted files@@ Coverage Diff @@
## main #189 +/- ##
===========================================
- Coverage 86.52% 30.59% -55.94%
===========================================
Files 10 8 -2
Lines 631 572 -59
Branches 63 0 -63
===========================================
- Hits 546 175 -371
- Misses 77 397 +320
+ Partials 8 0 -8
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Automatically approving PR from repo owner
🧪 CI InsightsHere's what we observed from your CI run for e509de9. 🟢 All jobs passed!But CI Insights is watching 👀 |
|
This pull request has been removed from the queue for the following reason: The merge conditions cannot be satisfied due to failing checks: You can check the last failing draft PR here: #208. You may have to fix your CI before adding the pull request to the queue again. |
Merge Queue Status
🚫 The pull request has left the queue (rule: This pull request spent 1 hour 32 minutes 24 seconds in the queue, including 1 hour 31 minutes 27 seconds waiting for CI. Required conditions to merge
ReasonThe merge conditions cannot be satisfied due to failing checks Failing checks: HintYou may have to fix your CI before adding the pull request to the queue again. |
Merge Queue Status
✅ The pull request has been merged This pull request spent 33 minutes 11 seconds in the queue, including 27 minutes 50 seconds waiting for CI. Required conditions to merge
|
User request: "look at all local branches for unmerged commits, create PRs if they are found by first merging origin/main and submitting the commit data"
This branch contains 1 unmerged commit(s). Conflicts resolved automatically with aggressive strategy.
Co-Authored-By: Claude noreply@anthropic.com