Skip to content

Fix dead Chakra UI, PublicTechnology, and Sphinx doc links #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
olitreadwell wants to merge 3 commits into from
Closed

Fix dead Chakra UI, PublicTechnology, and Sphinx doc links #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b8f8807
Fix dead Chakra UI style props link
olitreadwell Aug 5, 2026
711b2bb
Fix dead PublicTechnology interview link
olitreadwell Aug 11, 2026
0ec7d90
Fix dead Sphinx 3.x doc links
olitreadwell Aug 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions clients/python/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,15 +166,15 @@ Supposing all your domains, except "foo.bar", properly implement DMARC:

### Build Docs

The client comes with documentation generated by [Sphinx](https://www.sphinx-doc.org/en/3.x/index.html) from the docstrings in the source code. Because of this, they are not included in the GitHub repo. To build the docs you will first need to install Sphinx.
The client comes with documentation generated by [Sphinx](https://www.sphinx-doc.org/en/master/index.html) from the docstrings in the source code. Because of this, they are not included in the GitHub repo. To build the docs you will first need to install Sphinx.

The simplest way to ensure you have Sphinx installed is to install the client's dev dependencies with pipenv:

```bash
pipenv install --dev
```

If you don't wish to use pipenv, see the Sphinx [installation instructions.](https://www.sphinx-doc.org/en/3.x/usage/installation.html)
If you don't wish to use pipenv, see the Sphinx [installation instructions.](https://www.sphinx-doc.org/en/master/usage/installation.html)

Once Sphinx is installed, navigate to the `/docs` directory located in the Python client project root and run:

Expand Down
4 changes: 2 additions & 2 deletions frontend/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Before diving into the details of the development workflow itself, it's worth ta
### The philosophy

Applications without APIs project organizational silos into the digital space.
With an API, experiences can be created that are [centered on the user](https://www.publictechnology.net/articles/features/interview-singapore%E2%80%99s-digital-chief-redesigning-government-around-%E2%80%98moments-life%E2%80%99) rather than organizational silos.
With an API, experiences can be created that are [centered on the user](https://www.publictechnology.net/2019/07/26/international-relations/interview-singapores-digital-chief-redesigning-government-around-moments-life/) rather than organizational silos.

By adopting a microservices approach we can lay the foundation for a user centered service, and our new application can fit with the [TBS Directive on Management of Information Technology](https://www.tbs-sct.gc.ca/pol/doc-eng.aspx?id=15249#claD.2.2.4), but the developer workflow around this isn't clear.

Expand Down Expand Up @@ -99,7 +99,7 @@ These elements support the use of variables and any other Javascript inside them

The frontend user interface is styled using [Chakra](https://chakra-ui.com/).
Chakra contains many React components that are used for designing page layouts.
Chakra also allows for the use of ['style props'](https://chakra-ui.com/docs/features/style-props), which apply css properties to components.
Chakra also allows for the use of ['style props'](https://v2.chakra-ui.com/docs/styled-system/style-props), which apply css properties to components.
Chakra comes with a default theme, that Tracker extends in [/frontend/src/theme/canada.js](https://github.com/canada-ca/tracker/blob/master/frontend/src/theme/canada.js).
The theme contains colour, size, and spacing definitions, along with default component styles and custom component variants.

Expand Down