Skip to content

Improve documentation navigation and organization #14876

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

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

asafashirov
Copy link
Contributor

This PR improves the organization and navigation of our documentation files:

  • Creates CLAUDE.md with essential commands and guidelines for Claude Code AI
  • Consolidates UX-STANDARDS.md into STYLE-GUIDE.md for comprehensive guidance
  • Enhances CONTRIBUTING.md with better navigation and organization
  • Adds cross-references between all documentation files

These changes make our documentation more discoverable and easier to navigate while preserving all valuable technical content.

- Add support for processing all sitemap files (not just main sitemap)
- Implement section filtering capability
- Enhance error handling and progress tracking
- Improve reporting with a complete list of broken links
- Add reference guide for Claude Code AI
- Include essential commands for build, testing, and validation
- Include key guidelines with references to other documentation files
- Organize content into logical sections
- Avoid duplication by referencing other files for detailed information
- Merge UX standards into the style guide for comprehensive guidance
- Add section for component usage recommendations
- Include link recommendations for buttons and links
- Maintain all original guidance from both documents
- Add cross-references to related documentation files
- Add quick navigation section at the top
- Create task-oriented "What would you like to do?" section
- Add testing and common commands sections
- Add additional resources section with links to related docs
- Preserve all existing technical content and guidance
- Add related documentation sections to all files
- Create navigation links between documents
- Ensure consistent references across the documentation
- Improve SEO.md with proper title and introduction
- Enhance discoverability of related documentation
Copy link
Contributor

@dirien dirien left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would love to use the oppertunity to create test cases for the check-link.js logic.

I cant't tell if your changes you made are fine.

@pulumi-bot
Copy link
Collaborator

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants