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.

Sign up for GitHub

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

Jump to bottom

docs: new page with mdbook #8342

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: new page with mdbook #8342

wants to merge 1 commit into from

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
@poweifeng
docs: new page with mdbook
80d86a5 
 - 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@romainguy romainguy Awaiting requested review from romainguy

@pixelflinger pixelflinger Awaiting requested review from pixelflinger

@z3moon z3moon Awaiting requested review from z3moon

@bejado bejado Awaiting requested review from bejado

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
internal Issue/PR does not affect clients
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@poweifeng