Skip to content

How do you manage to have such nice, consistent README's? #95

Answered by wooorm
tefkah asked this question in Q&A
Discussion options

You must be logged in to vote

Thanks for your kind words, @tefkah!
Most questions/issues/etc are a bit entitled, or at least frustrated in the moment. Or just cold. So it’s really nice to see such messages! Makes my day.

On to How: well, it’s all pretty manual. I go through most projects like once every one or two years. Make sure things are consistent.
Recently, with types and ESM, that was a lot of the focus, a lot of breaking changes.
I’ve also been trying to get the docs better with the “what is this”, “when should I use this”, “security”, “types” sections, for the parsing project a “syntax”, for the AST projects a “syntax tree”, and for the high-level projects with lots of users an “examples” section.

It’s a bit …

Replies: 1 comment 2 replies

Comment options

You must be logged in to vote
2 replies
@matthias-ccri
Comment options

@wooorm
Comment options

Answer selected by wooorm
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Category
Q&A
Labels
📚 area/docs This affects documentation
3 participants