Comments (9)
yeah so a docusaurus + algolia setup maybe in order. well if you’d like to try an mvp i’d be happy to deploy and point people to it!
from react.
docusaurus maintainers are pretty responsive, just reach out im sure your usecase isnt new!
even tho i help maintain docz, its kinda dead right now. would recommend docusaurus.
from react.
Yooo I just came across this. Let's do itttt. I could start spinning it up?
from react.
this hasn't been as high of a priority since i split the single cheatsheet out to multiple. so far i've had no complaints. do you think its a priority? i personally no longer do
from react.
I think the big benefit would be improved navigation. I usually ctrl+f to find things, but when I’m looking for “refs”, for instance, I’ll have to skip through a few different results to find what I need. Having a table of contents would help with discovering things you didn’t even know you wanted to know, as well.
I actually missed that there was an Advanced section until the other day. I also think I’ve had a time or two where the syntax or tip I was looking for was hidden in one of the accordions.
I think you could even just keep it as two big documents in docusaurus, but have the sidebar. I’m not sure about splitting it into a bunch of documents, necessarily. Maybe it’d be a good idea, but I’d want to request feedback from people who use it to make sure we weren’t making a worse experience by changing things.
from react.
Wanted to get your thoughts on organizing the docs.
There's a lot of great information in here that gets lost in the mix because it's intermingled with the material on typing the React API/common patterns. How do you feel about isolating the React API material into a "How To Type" section?
Unfinished draft so far:
Setup:
Prerequisites
React + TypeScript Starter Kits
Import React
How To Type:
Props
Basic Prop Types Examples
Useful React Prop Type Examples
Tip: Comments on Props
Function Components
Class Components
Hooks
useState
...
Default Props
Events & Forms
Refs (createRef/forwardRef)
Context
Portals
Error Boundaries
Concurrent React/React Suspense
Reusable Components
Higher Order Components
Render Props
`as` props
FAQ:
Types or interfaces?
Helpful Tools & Utilities:
Utility Types
Type Zoo
Recipes/Patterns:
Props: One or the other but not both
Props: Must Pass Both
Props: Can Optionally Pass One Only If the Other Is Passed
Omit Attribute from a type
Type Zoo
Extracting prop types of a component
Handling Exceptions
Creating React + TypeScript Libraries
Third Party Libraries
Dealing with broken @types packages
It'd be cool to be able to surface all of the non-API stuff people should know in an easily discoverable way. For example, I didn't realize there was a way to import React normally with TS, since I use this as a reference, and never read the Setup section!
from react.
hmm! sure. this can be useful as a broader re-examination of the structure we have right now. it wasnt quite a conscious design, it just kinda grew.
from react.
not really liking working with docusaurus, and having trouble getting it to do what I want. Trying to get one that’ll show the main sections and subsection headings in the left sidebar, but coming up empty.
Docz is super easy to work with, but those sub-sections aren’t shown in the sidebar unless you’re on the page for that section
from react.
done thanks to @slorber :) #233
from react.
Related Issues (20)
- [Basic] useReducer: type safe dispatcher call HOT 2
- "Props: One or the Other but not Both" does not work HOT 2
- [Question] QUESTION_TITLE_HERE
- [Advanced] Wrapping/Mirroring a Component with ref forwarding
- facing errors
- not working
- Gene Piki wants to pay 0 USD to have this issue fixed
- JSX.Element is Deprecated HOT 11
- [Bug] The logo text is overflowing in small devices it should be truncate like mobile navigation. HOT 5
- Update CSS So that website can be accessible from any device of any width -- Solved HOT 8
- [Basic] Add resources to basic/recommended/talks.md HOT 3
- [Basic] Want to Fix Navbar Text Issue Without Truncating And Decreased Footer Logo Size Responsively For all Devices HOT 3
- Table of Content HOT 2
- Linked article on defaultProps docs is paywalled HOT 3
- add as a contributor? HOT 7
- [Basic] Linting page links are not working HOT 6
- CLASS METHODS AND CLASS PROPERTIES TITLES INTERCHANGED HOT 3
- [Advanced] ISSUE_TITLE_HERE
- [Advanced] Restrict useage of child component only as a child of a particular component HOT 3
- [Basic] Provide some docs on `memo` HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from react.