Change mdbook setup #8816
Merged
Change mdbook setup #8816
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
wmontwe
requested review from
coreycb,
jfx2006,
dandarnell,
cketti and
kewisch
as code owners
wmontwe
force-pushed
the
change-mdbook-setup
branch
from
35f80a6 to
181e86c
Compare
wmontwe
force-pushed
the
change-mdbook-setup
branch
from
181e86c to
9b9d554
Compare
wmontwe
force-pushed
the
change-mdbook-setup
branch
from
9b9d554 to
0336beb
Compare
kewisch
approved these changes
Feb 17, 2025
| @@ -0,0 +1,3 @@ | |||
| # About Thunderbird for Android | |||
|
|
|||
| This document provides an overview of the Thunderbird for Android project. | |||
There was a problem hiding this comment.
It might make sense to add link to the generated docs here, for people browsing the folder.
There was a problem hiding this comment.
How does this file relate to SUMMARY.md. Do we need both?
There was a problem hiding this comment.
The SUMMARY.md is used to define the navigation within the docs.
The README.md is empty at the moment, but it should be extended to give developers and contributors a quick overview of the docs content. I thought about the same approach as: https://developer.thunderbird.net/
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request includes several changes to improve the documentation and its deployment process. The most important changes include the addition of a GitHub Actions workflow for deploying documentation, updates to the documentation files, and improvements to the documentation's theme and structure. It fixes the issues found by
mdbook testand introduces an install script to simplifymdbooksetup process.The deployment publishes the page in
docs/latestto keep existing changelogs available.