Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mega-list of documentation ideas #2197

Closed
jamiebuilds opened this issue Aug 5, 2016 · 3 comments
Closed

Mega-list of documentation ideas #2197

jamiebuilds opened this issue Aug 5, 2016 · 3 comments

Comments

@jamiebuilds
Copy link
Contributor

@jamiebuilds jamiebuilds commented Aug 5, 2016

This list is never going to be truly complete, but I wanted to publicly document all the things I've been making note of that need to be done.

I'll keep adding to this for awhile...

@avikchaudhuri
Copy link
Contributor

@avikchaudhuri avikchaudhuri commented Aug 6, 2016

Small comment on "magic" types: they are magic precisely because they're not very well-designed...they are used carefully in the libs to enable us to express some stuff, but often are not very reliable when used in more general contexts. Some of them have definitely reached graduation age, though.

We could of course document them as is, but need to put disclaimers around their general use.

@jamiebuilds
Copy link
Contributor Author

@jamiebuilds jamiebuilds commented Aug 9, 2016

Should the "graduation" age ones be marked as such somehow? Like $Keys<T> could become Keys<T>?

@Brianzchen
Copy link
Collaborator

@Brianzchen Brianzchen commented Aug 26, 2020

A lot if not all of these docs have been added in the past 4 years
https://flow.org/en/docs/cli/
https://flow.org/en/docs/install/
https://flow.org/en/docs/types/utilities/#toc-keys

@jamiebuilds I know you've moved on from Flow, but if you feel there's still missing docs, we can reopen or start a new issue.

@Brianzchen Brianzchen closed this Aug 26, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
3 participants