Skip to content

Conversation

tim-lai
Copy link
Contributor

@tim-lai tim-lai commented Sep 20, 2022

Description

Add custom section for Additional documentation topics that provide external links for further reading.

Motivation and Context

Trim lengthy original full documentation.

Ref: #2040

How Has This Been Tested?

local. Refer to #2040 for fixture

Screenshots (if appropriate):

ls-pr-2048-media-type-additional-topics

Checklist

My PR contains...

  • No code changes (src/ is unmodified: changes to documentation, CI, metadata, etc.)
  • Dependency changes (any modification to dependencies in package.json)
  • Bug fixes (non-breaking change which fixes an issue)
  • Improvements (misc. changes to existing features)
  • Features (non-breaking change which adds functionality)

My changes...

  • are breaking changes to a public API (config options, System API, major UI change, etc).
  • are breaking changes to a private API (Redux, component props, utility functions, etc.).
  • are breaking changes to a developer API (npm script behavior changes, new dev system dependencies, etc).
  • are not breaking changes.

Documentation

  • My changes do not require a change to the project documentation.
  • My changes require a change to the project documentation.
  • If yes to above: I have updated the documentation accordingly.

Automated tests

  • My changes can not or do not need to be tested.
  • My changes can and should be tested by unit and/or integration tests.
  • If yes to above: I have added tests to cover my changes.
  • If yes to above: I have taken care to cover edge cases in my tests.
  • All new and existing tests passed.

@tim-lai tim-lai force-pushed the feat/oas31-docs-media-type-2-more-topics branch from 6dc241e to a541cee Compare September 20, 2022 17:17
@tim-lai tim-lai changed the title feat(ls): oas31 docs addtional topics for Media Type object feat(ls): oas31 docs additional topics for Media Type object Sep 20, 2022
@tim-lai tim-lai merged commit 9b22037 into main Sep 20, 2022
@tim-lai tim-lai deleted the feat/oas31-docs-media-type-2-more-topics branch September 20, 2022 17:31
@tim-lai tim-lai changed the title feat(ls): oas31 docs additional topics for Media Type object feat(ls): additional topics for OpenApi 3.1.0 Media Type object docs Sep 20, 2022
@tim-lai tim-lai added enhancement New feature or request OpenAPI 3.1 ApiDOM labels Sep 20, 2022
@tim-lai tim-lai self-assigned this Sep 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant