TianoCore Documents Layout

Documents are stored in GIT repositories in the TianoCore-Docs project on GitHub. Each document is stored in its own repository. Document repositories are named using <project name>-<specification name>. Example: edk2-BuildSpecification

The following shows the layout of files and directories for a document:

├──Document Repository
    ├───.gitignore               Ignore NPM files and local document builds
    ├───CONTRIBUTIONS.TXT        Tiano Contribution Agreement 1.1
    ├───LICENCE.TXT              BSD for Documentation
    ├───book.json                Title, Version, Draft/Release
    ├───cover.jpg                Book cover artwork
    ├───SUMMARY.md               Table of Contents
    ├───GLOSSARY.md              Optional
    ├───README.md                Acknowledgments, Revision History
    ├───1_<chapter title>        Chapter subdirectory
            ├───README.md        Chapter introduction
            ├───11_<section>     Section
            . . .                Additional sections
    . . .                        Additional chapters
    ├───media                    Tianocore logo and figures (PNG/JPG)
    ├───styles                   Custom Style Sheets (CSS)
    ├───_layouts                 Default Theme Overrides

See the edk2-TemplateSpecification for a complete example. A new document can be started by making a copy of the edk2-TemplateSpecification and performing the following additional steps:

• Update the title and version in book.json.
• Update the title in cover.jpg.
• Update Copyright and Revision History in README.md.
• Remove the chapter1.md and chapter2.md
• Add MarkDown files(.md) for chapters and sections in the new document.
  • If chapters are short, then put a single MarkDown file for the chapter in the root directory.
  • If chapters are long and composed of many sections, then create a directory for the chapter and add MarkDown files for each section in the chapter directory.
• Update the contents of the media directory with images used in the new document. Do not remove or modify the file media/TianoCoreTitlePageLogo.jpg. This image is referenced by README.md to add a TianoCore logo to the document title page.
• Update SUMMARY.md with the links to the chapters, sections, tables, figures, and examples.
• Add optional GLOSSARY.md with definitions of terms used in the new document. GitBook automatically adds hyperlinks to term definitions if this file is present.
• Do not modify or remove the .gitignore, CONTRIBUTIONS.TXT, or LICENSE.TXT files.
• Do not modify or remove the contents of the styles or _layouts directories.

Back to TianoCore Documents Overview