Skip to content

Conversation

@root-hbx
Copy link
Member

@root-hbx root-hbx commented Dec 4, 2025

Add a comprehensive documentation website for StarPerf based on mdBook.

This PR is marked as a draft for review purposes. It will be merged once all requirements are met:

  • Verify Content: Texts and validate code snippets for every chapter.
  • Refine Layout: Formatting and visual presentation.
  • Merge: Merge this PR into the main branch.
  • CI/CD Validation: Test web deployment workflow in CI/CD pipeline to ensure successful access by URL.
  • Visualization Integration: We will defer this feature to a follow-up PR.

Reason for Change

The current documentation (docs/interface_convention.pdf) has several limitations:

  • Difficult to navigate through long documentation
  • Hard to maintain and update incrementally

This web-based solution provides:

  • Web-based, searchable documentation with clear hierarchy
  • Easy to maintain and extend
  • Auto-CI/CD for GitHub Pages

Evaluation

Local deployment looks good, remaining for CI/CD test in our official repo.

image image

@root-hbx root-hbx added the documentation Improvements or additions to documentation label Dec 4, 2025
@gemini-code-assist
Copy link

Important

Installation incomplete: to start using Gemini Code Assist, please ask the organization owner(s) to visit the Gemini Code Assist Admin Console and sign the Terms of Services.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant