Feature/docs template #207
Merged
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
this is useful for preparing kit modules for publishing without running "foundation docs"
this is now separated out into "kit compile" command
this allows us to easily tweak the generated sites content and potentially even swap out vuepress etc., giving collie users much better control over generated docs
also format files and tweak error message if foundation/docs module is not installed
JohannesRudolph
force-pushed
the
feature/docs-template
branch
from
a4f3b02
to
6986664
Compare
Jelledb
approved these changes
Jul 6, 2023
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.
Generate docs leveraging templates shipped in a well-known "foundation/docs" kit module
Here's an example of the UX where the user doesn't have that well known kit module in their local repo
You can find the template here meshcloud/collie-hub#5
(collie kit import will only work once that's been merged to main)
I think the UX is quite good considering collie kit import will be essential to our user's workflows anyways. Also allows for easy tweaking of the template going forward