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

Merge api/ref/types and api/ref/metadata pages and correct links, including from generated context docs #1282

Open
kriswest opened this issue Jul 22, 2024 · 1 comment
Labels
docs Documentation needs-pr
Milestone

Comments

@kriswest
Copy link
Contributor

The division of the utility types used as arguments or return values from API calls into types and metadata is somewhat arbitrary, are not reflected in the sourcecode they represent and can be confusing. Further, it makes it very hard to generate links to the right documentation pages from other generated documentation (Context type references pages are now generated from the schema files).

I propose that we:

  • Merge the types and metadata pages together and stick to 'types'
  • Configure a docusuaurus redirect for 'metadata' page links to the 'types' page
  • Update the generated pages for context docs to create links for any API types (e.g. on the Action page):
    image
@kriswest kriswest added enhancement New feature or request docs Documentation and removed enhancement New feature or request labels Jul 22, 2024
@kriswest
Copy link
Contributor Author

I think this is probably how you set-up redirects in docusaurus: https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-client-redirects

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation needs-pr
Projects
None yet
Development

No branches or pull requests

1 participant