Add API Reference and Guides for TypeScript in docs#2266
Merged
meganelacheny merged 20 commits intomainfrom Nov 6, 2024
Merged
Add API Reference and Guides for TypeScript in docs#2266meganelacheny merged 20 commits intomainfrom
meganelacheny merged 20 commits intomainfrom
Conversation
Created new markdown files for API Reference and Guides under TypeScript development. Updated sidebar configuration to include these new sections and added corresponding links and placeholders.
This guide covers prerequisites, type imports, and usage examples for working with Strapi documents and components using TypeScript. It includes detailed sections on generic and known entities, advanced use-cases, and type argument inference to enhance type safety and development efficiency.
Updated the tags in the TypeScript development documentation to include 'api reference' and 'guides' for better categorization and easier navigation. This helps users find relevant information more efficiently.
Convly
added
source: Dev Docs
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
pwizla
reviewed
Oct 21, 2024
Collaborator
pwizla
left a comment
pwizla
left a comment
There was a problem hiding this comment.
Thank you, JS! Super useful changes.
I left lots of purely technical writing-oriented comments.
Happy to discuss things with you if you want, or just apply most of them, depending on what you prefer 🤗
docusaurus/docs/dev-docs/typescript/development/guides/documents-and-entries.md
Outdated
Show resolved
Hide resolved
docusaurus/docs/dev-docs/typescript/development/guides/documents-and-entries.md
Show resolved
Hide resolved
docusaurus/docs/dev-docs/typescript/development/guides/documents-and-entries.md
Outdated
Show resolved
Hide resolved
docusaurus/docs/dev-docs/typescript/development/guides/documents-and-entries.md
Outdated
Show resolved
Hide resolved
docusaurus/docs/dev-docs/typescript/development/guides/documents-and-entries.md
Show resolved
Hide resolved
| - reference | ||
| --- | ||
|
|
||
| # API Reference |
Collaborator
There was a problem hiding this comment.
Until this page has some more content, I'd suggest we don't link to it from the sidebar and the TypeScript intro. page.
If you want to inform users that an API reference is in the works, I'd suggest you use the special :::strapi callout in the TypeScript development intro. page.
See my comment in the TypeScript development file :)
Collaborator
There was a problem hiding this comment.
Sorry, just taking over here while @Convly is off and don't fully understand what we would need to change. Could you update it the way you think would work best?
docusaurus/docs/dev-docs/typescript/development/guides/documents-and-entries.md
Show resolved
Hide resolved
…ts-and-entries.md
…ts-and-entries.md
…ts-and-entries.md
…ts-and-entries.md
…ts-and-entries.md
…ts-and-entries.md
…ts-and-entries.md
…ts-and-entries.md
…ts-and-entries.md Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>
…ts-and-entries.md Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>
…ts-and-entries.md Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>
Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>
Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>
Collaborator
innerdvations
left a comment
innerdvations
left a comment
There was a problem hiding this comment.
Looks good so far, just had some of the same comments as Piwi had
pwizla
added
the
temp - port to docs-next
pwizla
removed
the
temp - port to docs-next
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
4 participants
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.
What does it do?
Add the first version for the first typescript guide in the documentation
Why is it needed?
Part of our effort to ease the adoption of TypeScript in Strapi