-
Notifications
You must be signed in to change notification settings - Fork 15
having git commands document on github pages #317
Conversation
|
@dennisseah we should update the release instructions to include instructions about running |
@andrebriggs, I have chosen to update |
andrebriggs
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
related to microsoft/bedrock#976
under docs/commands, we have
data.json - contains information of all commands
spk.js - fetch data.json and render the commands accordingly.
in package.json, we added a command,
build-cmd-docs. so we can call it once we release a new SPK version,yarn build-cmd-docs. This command creates docs/commands/data.json. Implementation of this command is intools/generateDoc.ts@andrebriggs, please enable github pages once this PR is merged. and the url to this page should be
https://catalystcode.github.io/spk/commands/index.html
it should look like this https://dennisseah.github.io/simple/commands/index.html
I only have the md file for spk init. The rest of the team members have to chime in to create the rest of the md files. Or I can get them from guides folder