chore: remove manual Index section from Promotions & Taxes API overview#1698
Open
PedroAntunesCosta wants to merge 2 commits into
Open
chore: remove manual Index section from Promotions & Taxes API overview#1698PedroAntunesCosta wants to merge 2 commits into
PedroAntunesCosta wants to merge 2 commits into
Conversation
|
Thanks for your contribution. The .json file will be checked now with Spectral. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
Until last week, the API reference overview page on the Developers Portal rendered as a client-side RapiDoc embed. Because Google sees almost no server-rendered content on those pages, our API reference overviews were not being indexed and the overview content (description, list of endpoints, etc.) was effectively invisible to search engines.
vtexdocs/devportal#1226 (EDU-16758) fixed this by:
<h1>title + full markdown description + auto-generated Endpoints table).noindex, and enabling ISR.Because the new renderer now generates the Endpoints section automatically from each spec's
paths, the manually-maintained## Indexsection that we used to write inside everyinfo.descriptionis now redundant. Keeping both would mean the same endpoint list appears twice on every overview page.What this PR does
Removes the
## Indexsection fromVTEX - Promotions & Taxes API.json'sinfo.description. No other field is touched. The auto-generated Endpoints section on the Developers Portal continues to list every operation in the spec.Verification
info.descriptionis still valid markdown and ends cleanly at the previous section's last paragraph (or at the next## Heading).git diffonly touches the description line).Related
Types of changes
Changelog
Do not forget to update your changes to our Developer Portal's changelog. Did you create a release note?