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

Post: Read the Docs loves Ruby #268

Merged
merged 8 commits into from
Mar 5, 2024
Merged

Post: Read the Docs loves Ruby #268

merged 8 commits into from
Mar 5, 2024

Conversation

humitos
Copy link
Member

@humitos humitos commented Feb 20, 2024

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 humitos marked this pull request as ready for review March 4, 2024 11:30
@humitos humitos requested a review from a team as a code owner March 4, 2024 11:30
@humitos humitos requested a review from ericholscher March 4, 2024 11:30
Copy link
Member

@ericholscher ericholscher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Short and sweet. This is great SEO/marketing content. We should probably also copy the demo & config over to a documentation page highlighting support for Jekyll or similar, but this is a great start. πŸ’―

content/posts/read-the-docs-loves-ruby.md Outdated Show resolved Hide resolved
content/posts/read-the-docs-loves-ruby.md Outdated Show resolved Hide resolved
content/posts/read-the-docs-loves-ruby.md Outdated Show resolved Hide resolved
content/posts/read-the-docs-loves-ruby.md Outdated Show resolved Hide resolved
content/posts/read-the-docs-loves-ruby.md Outdated Show resolved Hide resolved
content/posts/read-the-docs-loves-ruby.md Outdated Show resolved Hide resolved
@humitos
Copy link
Member Author

humitos commented Mar 4, 2024

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 #263 (comment)

@ericholscher
Copy link
Member

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

@humitos humitos merged commit cc458fb into main Mar 5, 2024
4 checks passed
@humitos humitos deleted the humitos/post-ruby branch March 5, 2024 08:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Blog: Read the Docs ❀️ Ruby
2 participants