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

Rework OpenPayments documentation #299

Closed
huijing opened this issue Sep 22, 2023 · 0 comments · Fixed by #300
Closed

Rework OpenPayments documentation #299

huijing opened this issue Sep 22, 2023 · 0 comments · Fixed by #300
Assignees
Labels
type: documentation Improvements or additions to documentation

Comments

@huijing
Copy link
Contributor

huijing commented Sep 22, 2023

We are in the process of migrating our OpenPayments documentation from readme.io over to our own hosted Starlight documentation site. This will happen as the actual content of the documentation is being updated.

Related issues to track:

Feature requirements

  1. Parse OpenAPI specification YAML into documentation pages (using https://github.com/HiDeoo/starlight-openapi)
  2. Be able to pull code snippets directly from https://github.com/interledger/open-payments-snippets, code should be able to be chunked up for easier explanation (built components for these)
  3. Ability to sync tabs such that code snippets of the selected language all are active at the same time (see Synced tabs withastro/starlight#953)

Blocking issues

  1. The plugin we are using does not parse all the fields in our specification as expected (see Certain fields are not parsed correctly HiDeoo/starlight-openapi#12) (Fixed)
  2. The most updated version of the plugin has an issue where the sidebar is unable to render (see Improve custom page injection withastro/starlight#982) (not exactly blocking per se)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation Improvements or additions to documentation
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants