Current Issue
The current DocC documentation URL structure is verbose:
- Root documentation page:
https://nakaokarei.github.io/SwiftAutoGUI/documentation/swiftautogui/
- Actual SwiftAutoGUI class page:
https://nakaokarei.github.io/SwiftAutoGUI/documentation/swiftautogui/swiftautogui
- The root documentation page doesn't provide much useful information since there's only one main class
Proposed Improvements
-
Create a Landing Page or Redirect
- Make the root documentation page (
/documentation/swiftautogui/) more useful
- Consider automatic redirect to the main SwiftAutoGUI class documentation
- Or create a proper landing page with project overview
-
Optimize URL Structure
- Adjust DocC configuration to reduce URL redundancy
- The repetition of "swiftautogui" in the path is confusing
-
Consider Custom Domain
- Set up a custom domain for shorter, more memorable URLs
Technical Considerations
- Adjust
--hosting-base-path parameter in the deployment workflow
- Utilize GitHub Pages custom 404 pages or redirect functionality
- Research DocC customization options for better URL structure
- Consider using index.html redirects at the documentation root
🤖 Generated with Claude Code
Co-Authored-By: Claude noreply@anthropic.com
Current Issue
The current DocC documentation URL structure is verbose:
https://nakaokarei.github.io/SwiftAutoGUI/documentation/swiftautogui/https://nakaokarei.github.io/SwiftAutoGUI/documentation/swiftautogui/swiftautoguiProposed Improvements
Create a Landing Page or Redirect
/documentation/swiftautogui/) more usefulOptimize URL Structure
Consider Custom Domain
Technical Considerations
--hosting-base-pathparameter in the deployment workflow🤖 Generated with Claude Code
Co-Authored-By: Claude noreply@anthropic.com