diff options
Diffstat (limited to 'docs/stdlib-docgen.md')
| -rw-r--r-- | docs/stdlib-docgen.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/stdlib-docgen.md b/docs/stdlib-docgen.md index df9317de9..0be3af548 100644 --- a/docs/stdlib-docgen.md +++ b/docs/stdlib-docgen.md @@ -19,7 +19,7 @@ rm -rf ./global-decls rm -rf ./attributes # generate updated pages -slangc -compile-stdlib -doc +slangc -compile-core-module -doc # optional: move generated toc.html to `_includes` mv toc.html ./_includes/stdlib-reference-toc.html @@ -96,7 +96,7 @@ as with `@remarks`. - Include examples if needed in the examples section. - Provide a see also section with links to related declarations. -After updating comments, build `slangc`, and run `slangc -compile-stdlib -doc` in `stdlib-reference` diretory to update the markdown files for preview. +After updating comments, build `slangc`, and run `slangc -compile-core-module -doc` in `stdlib-reference` diretory to update the markdown files for preview. Your PR only needs to include changes to *.meta.slang files. Once your PR is merged, slang CI will run `slangc` and push the updated markdown files to the `stdlib-reference` repo. @@ -111,4 +111,4 @@ C++'s visiblity modifiers: they apply to everything after it. To preview github pages locally, you need to follow instructions on setting up Jekyll: https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll -You will need to use Jekyll to create a Gem file before serving it.
\ No newline at end of file +You will need to use Jekyll to create a Gem file before serving it. |