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

Introducing basic API information and meta data information #152

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

fthobe
Copy link
Contributor

@fthobe fthobe commented Mar 6, 2025

Summary

This guide gives a very basic API overview, links the stoplight documentation, explains complimentary extensions and provides additional information about meta data.

Please backport also to 4.5 docs.

Checklist

  • I have followed the Diátaxis framework in my PR.
  • I have verified that the preview environment works correctly.

This guide gives a very basic API overview, links the stoplight documentation, explains complimentary extensions and provides additional information about meta data. 

Please backport also to 4.5 docs.
@fthobe
Copy link
Contributor Author

fthobe commented Mar 6, 2025

@kennyadsl can be merged.

Copy link
Member

@kennyadsl kennyadsl left a comment

Choose a reason for hiding this comment

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

Not sure why the metadata information should go in the API's getting started section. I think we should have a generic page for meta data, which explains basic concepts and usage. I'm ok with a section in the API on how to use them, but maybe it's not something for the getting started?

@fthobe
Copy link
Contributor Author

fthobe commented Mar 7, 2025

Hey, given that there's no frontend by default I think we should have it inside. If you prefer a different menu structure go crazy.

Where do you want to allocate meta? There's no chapter for it.

Shouldn't we maybe port the old docs?

@kennyadsl
Copy link
Member

Customization -> Customizing the core is the best place to explain this customization strategy, IMO.

@fthobe
Copy link
Contributor Author

fthobe commented Mar 7, 2025

Ok

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 this pull request may close these issues.

2 participants