Skip to content
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.

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

[ISSUE] Docs TOC links are broken #289

Closed
janvandervegt-db opened this issue Aug 16, 2023 · 0 comments · Fixed by #472
Closed

[ISSUE] Docs TOC links are broken #289

janvandervegt-db opened this issue Aug 16, 2023 · 0 comments · Fixed by #472

Comments

@janvandervegt-db
Copy link

Description
The Table of Contents in the SDK documentation links to anchors for the various topics but they do not work.

Reproduction
Go to the ToC.

Expected behavior
My browser should move to the corresponding topic

Debug Logs
N/A

Other Information
Chrome

Additional context
NA

@mgyucht mgyucht changed the title [ISSUE] [ISSUE] Docs TOC links are broken Aug 17, 2023
@mgyucht mgyucht mentioned this issue Dec 4, 2023
3 tasks
github-merge-queue bot pushed a commit that referenced this issue Dec 5, 2023
## Changes
This PR fixes readme links so that they work in PyPI, according to this
comment: pypa/readme_renderer#169.

I've also replaced the examples section of the readme to match what we
have in our documentation, which may be easier for folks to follow.

Resolves #289.

## Tests
<!-- 
How is this tested? Please see the checklist below and also describe any
other relevant tests
-->

- [ ] `make test` run locally
- [ ] `make fmt` applied
- [ ] relevant integration tests applied
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant