forked from MystenLabs/sui
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
New lint rules for new doc site (MystenLabs#14608)
## Description New lint rules for new doc site ## Test Plan Failed documentation test when files are modified in the old doc folder: `doc/tips/xcode-instruments.md` https://github.com/MystenLabs/sui/actions/runs/6724616879/job/18277279110?pr=14608 ![Screenshot 2023-11-01 at 1 15 16 PM](https://github.com/MystenLabs/sui/assets/15659060/fc20ea0a-0817-4090-ae7e-a9413e3ce5e0)
- Loading branch information
Showing
12 changed files
with
40 additions
and
20 deletions.
There are no files selected for viewing
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 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -12,20 +12,34 @@ jobs: | |
runs-on: [ubuntu-latest] | ||
outputs: | ||
isDoc: ${{ steps.diff.outputs.isDoc }} | ||
isOldDoc: ${{ steps.diff.outputs.isOldDoc }} | ||
steps: | ||
- uses: actions/checkout@7dd9e2a3dc350cf687eb1b2a4fadfee8c8e49675 # pin@v3 | ||
- uses: actions/checkout@v3 # pin@v3 | ||
- name: Detect Changes | ||
uses: './.github/actions/diffs' | ||
id: diff | ||
|
||
spelling: | ||
name: Lint documentation | ||
needs: diff | ||
if: needs.diff.outputs.isDoc == 'true' | ||
runs-on: [ubuntu-latest] | ||
|
||
steps: | ||
- uses: actions/checkout@7dd9e2a3dc350cf687eb1b2a4fadfee8c8e49675 # pin@v3 | ||
- uses: actions/checkout@v3 # pin@v3 | ||
- name: Spell Check Docs | ||
uses: crate-ci/[email protected] | ||
with: | ||
files: ./doc ./*.md | ||
files: ./docs/content | ||
|
||
old-doc-folder-notice: | ||
name: Old doc folder notice | ||
needs: diff | ||
if: needs.diff.outputs.isOldDoc == 'true' | ||
runs-on: [ubuntu-latest] | ||
|
||
steps: | ||
- name: Output error | ||
run: | | ||
echo "::error::Sui documentation has moved from doc/* to docs/content/* folder. (*.md files are now *.mdx)" | ||
exit 1 |
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 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 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 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 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 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
2 changes: 1 addition & 1 deletion
2
docs/content/guides/developer/getting-started/sui-environment.mdx
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 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 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 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