Skip to content

Create a library using mdbookshelf#4

Merged
jerrysxie merged 2 commits intoOpenDevicePartnership:mainfrom
philgweber:bookshelf
Mar 11, 2025
Merged

Create a library using mdbookshelf#4
jerrysxie merged 2 commits intoOpenDevicePartnership:mainfrom
philgweber:bookshelf

Conversation

@philgweber
Copy link
Copy Markdown
Collaborator

Added some overview documents and structures and web content for creating a library with multiple shelves.

I want to pull in this main structure then finish adding getting started and overview guides. The documentation is to be broken into the following areas (each area as a shelf):

Getting Started

  • Contains overview of all ODP
  • Contains guides on how to sync and build code generally
  • How to setup hardware and load builds and validate and test content on various platforms
  • Repository overview and organization

Projects

  • Keep to one mdbook per project that covers all the high level details of that given project with references to all the relevant repositories
  • Should have all the relevant information needed by someone working on a given project on how all the pieces fit together
  • Details specific about how to load a repository or compile and repository specific content should go into an mdbook in that specific repository

Tutorials

  • Video content should go to the Youtube channel https://www.youtube.com/@OpenDevicePartnership
  • Tutorials here can contain pictures and steps to walk people through particular concepts, projects or features. If it is a NOOB tutorial keep it in the Getting Started Section

Specifications

  • Reserve this section for publishing specifications that we want to publish to a wider audience

Further investigation needed for linking from books back to libraries and best practices for referencing from one book to another.

Prevents cluttering of git tracked files due to generated output.

Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
Copy link
Copy Markdown
Contributor

@jeffglaum jeffglaum left a comment

Choose a reason for hiding this comment

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

Great start! Thank you for putting this together. Minor edit suggestions.

Comment thread .github/workflows/buildbook.yml Outdated
Comment thread bookshelf/Shelf 1 Getting Started/overview/src/README.md Outdated
Comment thread bookshelf/Shelf 1 Getting Started/overview/src/README.md
Comment thread bookshelf/Shelf 1 Getting Started/overview/src/media/mptf.png Outdated
Comment thread bookshelf/Shelf 2 Projects/overview/src/README.md Outdated
Comment thread .github/workflows/buildbook.yml Outdated
Comment thread .github/workflows/buildbook.yml Outdated
Comment thread bookshelf/Shelf 1 Getting Started/overview/book.toml Outdated
Comment thread bookshelf/Shelf 1 Getting Started/overview/src/README.md Outdated
Comment thread bookshelf/Shelf 1 Getting Started/overview/src/README.md Outdated
Comment thread bookshelf/Shelf 1 Getting Started/overview/src/README.md Outdated
Comment thread bookshelf/Shelf 2 Projects/overview/book.toml Outdated
@jeffglaum jeffglaum moved this to In review in ODP Backlog Mar 6, 2025
Copy link
Copy Markdown
Contributor

@jeffglaum jeffglaum left a comment

Choose a reason for hiding this comment

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

Thanks Phil.

Copy link
Copy Markdown
Contributor

@jerrysxie jerrysxie left a comment

Choose a reason for hiding this comment

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

We probably want to squash the commits in this PR since we are not doing automatic squashing as the part of the commit history would be pointing to a forked branch that might or might not exist in the future.

@philgweber philgweber requested a review from jerrysxie March 11, 2025 15:11
@jerrysxie jerrysxie merged commit c8b54af into OpenDevicePartnership:main Mar 11, 2025
1 check passed
@github-project-automation github-project-automation bot moved this from In review to Done in ODP Backlog Mar 11, 2025
@philgweber philgweber deleted the bookshelf branch June 5, 2025 18:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

5 participants