docs: Documents are consistent with the website #1755
Conversation
|
There was a problem hiding this comment.
Thank you for making these changes! Unfortunately by the nature of these appearing both on GitHub AND npm, which don’t have the markdown customizations of the website, they must differ. Mainly this means:
- The link to docs have been removed; we MUST link to docs in READMEs!
- Relative links must be preserved
- No codefence filenames (this is a custom extension)
- “Tip” blocks as blockquotes are fine (that’s all we can do), but should only have one heading, not two.
There’s another point I didn’t comment on which is the docs open all remote links in a new tab, and the <a> tags do this in markdown. Removing the <a> tags actually makes them inconsistent with docs, so they won’t open a new tab. But I don’t care about this that much, and it’s probably just simpler to not have HTML in docs, so I’m OK with this change.
Other than that, happy to approve once these changes have been addressed!
* fix(docs): Document inconsistency * docs: format * docs: Document consistency * docs: update
Changes
Fix #1748
How to Review
Documents are consistent with the website
Checklist
docs/updated (if necessary)pnpm run update:examplesrun (only applicable for openapi-typescript)