📝 Overhaul the documentation #41
Merged
Conversation
This file contains hidden or 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
Contributor
Author
|
This pr is blocked by #38 to avoid merge conflicts. |
BattleCh1cken
force-pushed
the
feature/documentation-overhaul
branch
from
3cd4ad5 to
f6b778b
Compare
…attleCh1cken/notebookinator into feature/documentation-overhaul
BattleCh1cken
requested review from
Isaiah15414,
aji-ajani and
dblaufuss
and removed request for
dblaufuss
dblaufuss
reviewed
May 15, 2024
| - `globals.typ`: Contains all of the global variables for the entire project. | ||
| - `utils.typ`: Utility functions intended to help implement themes. | ||
| - `themes/`: The folder containing all of the themes. | ||
| - `themes.typ`: An index of all the themes are contained in the template |
Collaborator
There was a problem hiding this comment.
it has a tab because themes.typ is inside the themes/ folder
Collaborator
There was a problem hiding this comment.
I realize my mdbook was out of date.
Isaiah15414
approved these changes
May 15, 2024
Collaborator
Isaiah15414
left a comment
Isaiah15414
left a comment
There was a problem hiding this comment.
Looks great! Just fixed some typos, but everything reads very well
dblaufuss
reviewed
May 15, 2024
BattleCh1cken
force-pushed
the
feature/documentation-overhaul
branch
from
a1447a7 to
084b690
Compare
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.
Summary
This pull request migrates the documentation from a
.pdffile, which is hard to navigate for users, to a website rendered bymdbook.Checklist