Skip to content

Commit

Permalink
Update help messages for doc generation / spellchecking
Browse files Browse the repository at this point in the history
  • Loading branch information
banool committed Nov 21, 2022
1 parent 37fdb6b commit 91824bc
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion developer-docs-site/scripts/spellcheck.sh
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ done
if [ $everything_spelled_correctly -eq 0 ]
then
echo "Mispelled words were found 😭"
echo "If the typo is not actually a typo, add the word to developer-docs-site/scripts/additional_words.txt"
echo "If the typo is not actually a typo, add the word to developer-docs-site/scripts/additional_dict.txt"
echo
exit 1
else
Expand Down
4 changes: 2 additions & 2 deletions ecosystem/typescript/sdk/scripts/generate_ts_docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ mv /tmp/generated-ts-docs/* $DOCS_DIR
# Copy in a basic README
echo "# TS SDK Docs" > $DOCS_DIR/README.md
echo "" >> $DOCS_DIR/README.md
echo 'Generated from `ecosystem/typescript/sdk/` in [aptos-core](https://github.com/aptos-labs/aptos-core/tree/main/ecosystem/typescript/sdk). See the README there.' >> $DOCS_DIR/README.md
echo 'Generated from `ecosystem/typescript/sdk/` in [aptos-core](https://github.com/aptos-labs/aptos-core/tree/main/ecosystem/typescript/sdk) using `pnpm generate-ts-docs`.' >> $DOCS_DIR/README.md

# Done!
echo
echo "Generated docs to $DOCS_DIR"
echo "From here, ensure that the changes look good and make a PR if so!"
echo "From here, ensure that the changes look good. If so, copy the changes into a checkout of the ts-sdk-doc repo and make a PR!"

0 comments on commit 91824bc

Please sign in to comment.