feat(docs): add documentation website based on the Fermyon docs template #74
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
Signed-off-by: Radu Matei <radu.matei@fermyon.com>
This commit adds a documentation website in the `docs/` directory for Bartholomew. The website is based on the Fermyon docs website template, and is only focused on the Bartholomew documentation, and not on showcasing all of Bartholomew's potential features. As such, not all pages and templates have been kept from the previous top-level directories. Those should be part of the Bartholomew website template instead. Signed-off-by: Radu Matei <radu.matei@fermyon.com>
vdice
reviewed
May 10, 2022
| date = "2022-05-08T14:05:02.118466Z" | ||
|
|
||
| [extra] | ||
| url = "https://github.com/fermyon/bartholomew/blob/main/docs/content/contributing.md" |
There was a problem hiding this comment.
We may want to file an issue/reminder to populate this page.
There was a problem hiding this comment.
I think we could construct this using https://github.com/fermyon/bartholomew/blob/main/docs/content as base?
Signed-off-by: Radu Matei <radu.matei@fermyon.com>
|
I addressed all the comments, @vdice, I think this is ready for one final look. Thanks! |
vdice
approved these changes
May 16, 2022
There was a problem hiding this comment.
One very minor outstanding typo (#74 (comment)); other than that, LGTM!
Signed-off-by: Radu Matei <radu.matei@fermyon.com>
Closed
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.
Big thanks to @jdbohrman for starting the work on this.
supersedes #66
This commit adds a documentation website in the
docs/directory for Bartholomew.The website is based on the Fermyon docs website template, and is only focused on
the Bartholomew documentation, and not on showcasing all of Bartholomew's potential
features.
As such, not all pages and templates have been kept from the previous top-level
directories. Those should be part of the Bartholomew website template instead.
Signed-off-by: Radu Matei radu.matei@fermyon.com