ably / docs

Ably Realtime API documentation
https://ably.com/docs
Apache License 2.0
20 stars 41 forks source link

[WEB-3922] - Move the ControlAPI from website to docs #2247

Closed aralovelace closed 2 months ago

aralovelace commented 2 months ago

Description

Note for Future: In the Modernise UI (WEB-3426) this task adds the new Control API page needs to be updated and use the new font styling

A PR description indicating the purpose of the PR.

Review

Instructions on how to review the PR.

Preview - https://ably-docs-web-3922-gpfi4yshwf6.herokuapp.com/docs/api/control-api Compare it to the current page - https://ably.com/docs/api/control-api

m-hulbert commented 2 months ago

Could we call the DisplayRedoc component Loader, or Render, or event justDisplay? Then inindex.tswe can re-export it asRedoc`so it when we then render it we simply call``?

I also don't think we need an environment variable for the spec URL, it can just be provided by the caller. Just thinking ahead if we ever need to render other specs, then naming ENV vars becomes an issue.

What are your thoughts on just moving the spec file into the docs repo, rather than calling out to open specs? @kennethkalmer @aralovelace

kennethkalmer commented 2 months ago

What are your thoughts on just moving the spec file into the docs repo, rather than calling out to open specs? @kennethkalmer @aralovelace

I don't have a strong opinion on this @m-hulbert, because I don't have all the insights about these various open repos and their purpose. The "well groomed" spec needs a home somewhere, and as long as it is accessible over HTTPS we can fetch and render it.

If we want it in the repo we can simply drop it into static/open-specs/control-v1.yml and update the references.

aralovelace commented 2 months ago

thanks @kennethkalmer I have updated the components and remove the env variable Also as suggested by @m-hulbert the file is now local;