search

readthedocs / blog

Read the Docs blog
https://blog.readthedocs.com
18 stars 47 forks source link

Post about new configuration file #59

Closed stsewd closed 5 years ago

stsewd commented 5 years ago

I wasn't sure what to include, hope this first draft makes sense, feel free to point me any problem with the language/grammar/typos, etc D:

Should I included more technical details? Like we moved this module from a separated repo, and we did a lot of changes in the rtd code?

Should I include that this project was part of my internship in rtd?

ericholscher commented 5 years ago

Should I include that this project was part of my internship in rtd?

Yes!

I'd also include many more examples. I think now you're just stating benefits, but you should be showing people the benefits. Having some code examples of the YAML file would be a big win, especially around the neater stuff it can do.

Should I included more technical details? Like we moved this module from a separated repo, and we did a lot of changes in the rtd code?

I don't think this is important. Too "in the weeds".

stsewd commented 5 years ago

I've added some examples, and mention the internship (not sure if I should add more details here?). Also, I've mentioned some new stuff that we are planning (actually not sure if redirects will make it https://github.com/rtfd/readthedocs.org/issues/4221).

stsewd commented 5 years ago

I've expanded the post, I'm replacing the nested lists for paragraphs

ericholscher commented 5 years ago

👍 💯 🎉