Back-merge docs root redirect into develop#26
Merged
Conversation
## 📋 Release 1.1.0 First release since 1.0.4. Minor bump — adds new public API (`Options` initializer) and a documentation/CI overhaul. ### Added - **Public `Options` initializer** — construct `Options(...)` directly (was previously impossible from a consumer module; only `.setX()` modifiers worked). - **Unit test target** (`ProgressUITests`) — `Options` defaults/init, `Progressable.calculate(from:)`, `GrowDirection` alignment. - **DocC** catalog + **published to GitHub Pages** on release (via `swift-docc-plugin`). - Contribution guide, issue/PR templates, `CHANGELOG`. ### Changed - CI builds + tests across all 6 platforms; redundant runs avoided. ### Fixed - README "Dynamic Colors"/"Customization Options" examples now compile. - DocC symbol-link warnings cleaned up — docs build with **0 warnings**. ### Security - Least-privilege `GITHUB_TOKEN` (`contents: read`) on Build & Test (resolves CodeQL alerts). ### Verification - `xcrun swift test` → 9 tests, 0 failures. - DocC `generate-documentation` → 0 warnings (full audit completed). --- After merge: tag `1.1.0`, publish the GitHub Release, back-merge to `develop`, and the Pages deploy fires automatically. 🤖 Generated with [Claude Code](https://claude.com/claude-code)
The bare GitHub Pages URL rendered DocC's "page can't be found" because a DocC site has no root landing page. Overwrite the generated root index.html with a redirect to /documentation/progressui (per-route pages are unaffected). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
This PR back-merges the documentation site root redirect into develop, preserving the GitHub Pages fix that sends visitors from the bare Pages URL to the ProgressUI DocC module documentation.
Changes:
- Adds a workflow step after DocC generation to overwrite
./docs/index.html. - Uses a meta refresh and fallback link to redirect to
documentation/progressui.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Brings the docs-site root redirect (merged to main in #25) into develop so future releases keep it. Workflow-only change, already validated on main.
🤖 Generated with Claude Code