Skip to content

Commit 41ef445

Browse files
committed
Update documentation on building docs locally
Why are these changes being introduced: * Our deployed documentation ran into issues that required a config change that requires us to change how we load the docs locally How does this address that need: * documents how and why to access the documentations using `/timdex/` as part of the URL path
1 parent 4ca1072 commit 41ef445

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,9 @@ to ensure everything looks as expected.
7676
bundle exec jekyll serve --incremental --source ./docs
7777
```
7878

79-
Once the jekyll server is running, you can access the local docs at http://localhost:4000
79+
Once the jekyll server is running, you can access the local docs at http://localhost:4000/timdex/
80+
81+
Note: it is important to load the documentation from the `/timdex/` path locally as that is how it works when built and deployed to GitHub Pages so testing locally the same way will ensure our asset paths will work when deployed.
8082

8183
### Automatic generation of technical specifications from GraphQL
8284

0 commit comments

Comments
 (0)