Library introduction

[tremho]

Documentation and repository revisions.

I've revised the documentation repository itself to repurpose the "shelf" concept originally established by Phil Weber
although I've changed the workflow to not use mdbookshelf, but rather just mdbook and making the shelves separately.
I created a separately managed index.html for this, so that documentation/index.html can become the "Library" entrance.

(this is a very simple html file. It should probably be styled by the web team and added as the "Library" page for the ODP website).

There are 4 shelves defined - Introduction, Examples, Support, and Specifications

The material here is what was seen before in another (temporary) repository, and some of the content originally here was rearranged to fit the new shelf order.

I will be adding workflows to each of the other repositories so that each will release two github-pages hosted document trees -- /mdbook and /rustdoc so that the library can link to these with its shelf arrangement.

For any of these refitted repos, documentation is published by first making a version tag and then pushing to that tag.
This will build any mdbook content as well as cargo doc generation of API docs.

Each release will be archived as a GitHub Release under its version tag, and the latest one will have its docs available at https://opendevicepartnership.github.io/<repo_name>/mdbook/
and/or https://opendevicepartnership.github.io/<repo_name>/rustdoc/

Link references in other docs can point to this.

Steps:
After committing all changes to the repo, release a version by first creating a version tag:

e.g.: git tag v1.2.3

Then push changes to this tag git push origin v1.2.3

This will trigger the workflow process. After a few minutes, the content will be available at the links described above.

The uefi-dxe-core repository already has GitHub workflows attached, including publishing via github-pages. This uses a different mechanism for a different outcome, so I did not change anything here. The mdbook is still being published as before, but it appears at the root (redirected) and not the /mdbook folder like the other ones. Also, there is currently no cargo doc api doc generation for this repository.

I do not have write access for repositories other thatn this one, so I can not push the PR for the 'docs-gen.yml' workflow to them at this time.

[philgweber]

Just few comments other than that looks good.

[dhillonk]

A point of clarification for me: is Patina a codename or just the name for the project? @spbrogan @makubacki ?

[makubacki]

The name of the project.

[tremho]

My bad. I'm not sure why I chose that description. I will change it for the next submission to be something more like:

Patina is the name given to UEFI-compliant boot firmware developed using ODP patterns.

[makubacki]

No problem @tremho. Thanks for putting this together. Can you also update to the file name from "Pantina.md" to "Patina.md" in those changes as well?

[tremho]

Sure thing. Nice catch! Thanks.

…

On May 13, 2025, at 4:04 PM, Michael Kubacki ***@***.***> wrote: @makubacki commented on this pull request. In bookshelf/Shelf 1 Getting Started/overview/src/concepts/Pantina.md <#7 (comment)>: > @@ -0,0 +1,89 @@ +# Patina +## (Boot Firmware) + +___Patina___ is the codename for ODP's Rust-based SDK and framework for UEFI-compliant boot firmware development. No problem @tremho <https://github.com/tremho>. Thanks for putting this together. Can you also update to the file name from "Pantina.md" to "Patina.md" in those changes as well? — Reply to this email directly, view it on GitHub <#7 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAIE2YLXRI3OV4F5R2BTWQ326J3BXAVCNFSM6AAAAAB4PFSBA2VHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDQMZYGMYDSMRVGM>. You are receiving this because you were mentioned.