Skip to content

Commit b9102bd

Browse files
committed
📄 Update readme.hbs Template with Hosted Documentation Note
- Enhanced the `readme.hbs` template to include a crucial note on updating the `base_url` in `jsDocsConf.json`. - Guided users to change `localhost` to their actual documentation's hosted URL for `azure-pipelines-docs.yml`. - Ensured clear instructions for documentation setup in CI/CD workflow. - Improved overall guidance for project setup and configuration within the template.
1 parent b15f836 commit b9102bd

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

.ci/templates/README.hbs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Using the directory path `/SuiteScript/...`, we can provide aliases locally for
3737
- [`README.hbs`](./.ci/templates/README.hbs) -- Base template file the project README.md is generated from
3838
- [`npmrc`](./.npmrc) -- NPM environment token loader file for publishing project _(Note: the variable name `NPM_TOKEN` can be changed for multiple tokens)_
3939
- [`docsMD.config`](./.ci/config/docsMD.config.js) -- Wiki MD generator from JSDoc notations
40-
- [`jsDocsConf.json`](./.ci/config/jsDocsConf.json) -- JSDocs configuration file
40+
- [`jsDocsConf.json`](./.ci/config/jsDocsConf.json) -- JSDocs configuration file. **Important:** For hosted documentation, especially when using `azure-pipelines-docs.yml`, update the `base_url` in this file from `localhost` to your documentation's hosted URL.
4141

4242
## 🔨 Scripts
4343

0 commit comments

Comments
 (0)