search

readthedocs / website

The Read the Docs community website
15 stars 5 forks source link

Post: Read the Docs loves Ruby #268

Closed humitos closed 3 months ago

humitos commented 4 months ago

Initial content for the blog post.

✍🏼 Rendered version: https://read-the-docs-website--268.com.readthedocs.build/blog/2024/03/read-the-docs-loves-ruby/

Closes #255

📚 Documentation preview 📚: https://read-the-docs-website--268.com.readthedocs.build/

humitos commented 4 months ago

We should probably also copy the demo & config over to a documentation page highlighting support for Jekyll or similar

Yeah, I thought about this and I immediately thought about the "example projects". However, I always felt the "example projects" are too much for this use case. I would like to have something in between the test-builds branches (which are too dev-y) and the "example projects".

Maybe it's just a small documentation page per doctool where we define the .readthedocs.yaml file and explain why we use some of those options. For example --destination and other parameters. @agjohnson has a similar question in https://github.com/readthedocs/website/pull/263#issuecomment-1949173267

ericholscher commented 4 months ago

Yeah, I'm thinking something very simple, like a tools index with pages per tool.