Generated documentation and website#2
Merged
TristanFloch merged 4 commits intomainfrom Jul 19, 2023
Merged
Conversation
bb0fc8c to
fc96e88
Compare
240e3e6 to
131ad87
Compare
TristanFloch
commented
Jul 18, 2023
275bfd4 to
1deca99
Compare
bc64b8e to
f0737c8
Compare
bradishp
reviewed
Jul 18, 2023
Collaborator
bradishp
left a comment
There was a problem hiding this comment.
While this is not my area of expertise it all looks good to me.
I left some minor NITs and suggestions around the documentation. Once you have addressed those I am happy for this to merge in.
c980e96 to
f741cc5
Compare
f741cc5 to
e57f9e0
Compare
e57f9e0 to
50bd121
Compare
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
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.
The CI executes the following steps to generate the website:
go install).docs/api-reference, using the.github/templates/api-reference-md.tmpltemplate file.gh-pagesbranch using MkDocs Material.The website can be previewed here: https://aristanetworks.github.io/eossdkrpc.
Local build and preview instructions have been added to the README (that will be public).
The
EosSdkRpc HOWTOguide will be added to the documentation on the next PR: #3.Note: The CI currently publishes the
documentationbranch instead ofmainso everyone can have an overview of the generated website. I will change the publishing to master once this PR is approved.Other note: At the moment, one single workflow file both builds the api reference and deploys the website. It would be preferable to build the api reference on each push, and deploy the website from the main branch only.
A recent GitHub features allows this workflow split in a clean way, but it will only work when workflow files are on the default branch (see documentation note).
My intent is to split workflows after this PR merges.