Skip to content
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

docs: new page with mdbook #8342

Merged
merged 2 commits into from
Jan 14, 2025
Merged

docs: new page with mdbook #8342

merged 2 commits into from
Jan 14, 2025

Conversation

poweifeng
Copy link
Contributor

  • Use mdbook to generate a book from collection of documents
  • documents are
    • copied and processed from READMEs
    • original content stored in the docs_src folder - markdeep docs transformed into embedded html
  • Main logic is in script docs_src/build/run.py

@poweifeng poweifeng added the internal Issue/PR does not affect clients label Jan 9, 2025
 - Use mdbook to generate a book from collection of documents
 - documents are
     - copied and processed from READMEs
     - original content stored in the docs_src folder
     - markdeep docs transformed into embedded html
 - Main logic is in script docs_src/build/run.py
@poweifeng poweifeng enabled auto-merge (squash) January 14, 2025 06:42
@poweifeng poweifeng merged commit 026b985 into main Jan 14, 2025
12 checks passed
@poweifeng poweifeng deleted the pf/doc-refactor-1 branch January 14, 2025 06:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
internal Issue/PR does not affect clients
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants