Skip to content

Improve DocC documentation URL structure #31

@NakaokaRei

Description

@NakaokaRei

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

  1. 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
  2. Optimize URL Structure

    • Adjust DocC configuration to reduce URL redundancy
    • The repetition of "swiftautogui" in the path is confusing
  3. 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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions