dendron-site
dendron-site copied to clipboard
add guide for using viz cli cmd with gh action
What does this PR do?
In the note for publishing notes using Github Actions, add a guide on how to generate repo visualization using Dendorn: Visualize
cli command as a job.
template.publish.github-actions pr: https://github.com/dendronhq/template.publish.github-action/pull/7
What issues does this PR fix or reference?
- Fixes: OR
- Relates to:
NOTE:
Fixes
will close the ticket after merging.Relates to:
will leave the ticket open after merging.
Merge requirements satisfied
For more information, visit the Contributing Guide for Documentation
- [x] Check rendered output to ensure formatting is correct for renderings of wikilinks, note refs, tables, and images.
Dendron: Show Preview
can be used in your workspace to confirm the page renders as expected. Sometimes,Dendron: Reload Index
needs to be ran if certain wikilinks aren't working as expected. (ignore this if contribution is made via theEdit this page on GitHub
button from the published site) - [ ] If this PR includes any refactoring (renaming notes, renaming headers, etc.), make sure that these changes were done via Dendron Refactoring Commands. This will ensure that any other impacted areas of the documentation, that link to or embed modified notes (via note references), are automatically updated.
Verify GitHub Actions tests are passing, which can be seen in the Checks
tab of the PR:
- [ ]
URL validator
GitHub Action passes - [x]
Dendron site build
GitHub Action passes
NOTE: If you are a new contributor, a maintainer will need to provide approval for GitHub Actions to run on your PRs.