Skip to content

More docs cleanup: #168

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

Jump to bottom
Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

More docs cleanup: #168

wants to merge 2 commits into from

Conversation

tjotala
Copy link
Member

@tjotala tjotala commented Aug 8, 2025

  • Update partner connections screenshot
  • Fix a bug in the summary data % calculation
  • Remove unnecessary workflows
  • Clean-up obsolete references and scripts for publishing to Stoplight

@tjotala
More docs cleanup:
9676971 
- Update partner connections screenshot
- Fix a bug in the summary data % calculation
- Remove unnecessary workflows
- Clean-up obsolete references and scripts for publishing to Stoplight
@tjotala tjotala requested review from gniezen and toddkazakov August 8, 2025 00:10
@toddkazakov
Copy link
Contributor

@tjotala I see that you removed the branch preview GitHub actions, but the hosted preview seems to be failing. Is there a workaround to access the rendered not-yet-merged API docs?

@tjotala
Copy link
Member Author

tjotala commented Aug 8, 2025

@tjotala I see that you removed the branch preview GitHub actions, but the hosted preview seems to be failing. Is there a workaround to access the rendered not-yet-merged API docs?

How is the hosted preview failing? It shows up here for me:

https://app.cloud.redocly.com/org/tidepool/project/tidepool?branchName=tjotala%2Fdocs-cleanup&file=index.md

That said, I noticed that Markdoc (Redocly's flavor of Markdown) does not support LaTeX math equations and symbols... :-(

@toddkazakov
Copy link
Contributor

@tjotala the github action is failing - I assumed that the preview was not being published. That said, I don't have access to redocly and I don't see shared credentials in 1P. Can we get invites for the backend team and the QA team members that work on backend tickets?

gniezen
gniezen approved these changes Sep 4, 2025
View reviewed changes
Copy link
Member

@gniezen gniezen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tjotala I've taken the liberty of converting all the LaTeX equations to MathML (or just plain Markdown where possible)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gniezen gniezen gniezen approved these changes

@toddkazakov toddkazakov Awaiting requested review from toddkazakov

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@tjotala @toddkazakov @gniezen