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

Add Markdoc page to website marketing #336

Merged
merged 4 commits into from
Dec 12, 2024
Merged

Add Markdoc page to website marketing #336

merged 4 commits into from
Dec 12, 2024

Conversation

ericholscher
Copy link
Member

@ericholscher ericholscher commented Nov 21, 2024

This links to our newly created doc page


📚 Documentation preview 📚: https://readthedocs-about--336.org.readthedocs.build/

This links to our newly created doc page
Copy link
Member

@humitos humitos left a comment

Choose a reason for hiding this comment

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

This looks good to me.

Now, I feel that we are repeating ourselves by having a "marketing page" and a "documentation page" for every tool. I think we should think a little more about this to avoid this repetition.

We should highlight all the features that Read the Docs adds on top of any documentation tool here with nice copy, images and GIF examples in the marketing site with a list of all the supported doctools pointing to our specific documentation pages. This will simplify the maintenance and also show why Read the Docs is different than a regular hosting providing, promoting what we want to promote: our specific features.

What do you think?

content/includes/try-it-out-markdoc.html Outdated Show resolved Hide resolved
content/pages/tools/markdoc.html Outdated Show resolved Hide resolved
content/pages/tools/markdoc.html Outdated Show resolved Hide resolved
Co-authored-by: Manuel Kaufmann <humitos@gmail.com>
@ericholscher
Copy link
Member Author

ericholscher commented Nov 21, 2024

This looks good to me.

Now, I feel that we are repeating ourselves by having a "marketing page" and a "documentation page" for every tool. I think we should think a little more about this to avoid this repetition.

We should highlight all the features that Read the Docs adds on top of any documentation tool here with nice copy, images and GIF examples in the marketing site with a list of all the supported doctools pointing to our specific documentation pages. This will simplify the maintenance and also show why Read the Docs is different than a regular hosting providing, promoting what we want to promote: our specific features.

What do you think?

Strong agree. I just did the quick version to get some SEO out the door, but I definitely think we want to make these a bit more systematic and nicer over time with stuff that you mentioned.

@ericholscher
Copy link
Member Author

@humitos 👍 on merging this for now, and we can iterate on all the landing pages for style?

@ericholscher
Copy link
Member Author

@humitos would be good to either 👍 this, or maybe we close this out, and work on the refactor that we mentioned?

Copy link
Member

@humitos humitos left a comment

Choose a reason for hiding this comment

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

We can merge this 👍🏼 . Honestly, I don't think we are adding too much value here other than SEO since we are not explaining anything new in these pages.

I think the useful/important work is the refactor of these pages as we've been mentioning. That would give us the value the users are looking for.

@ericholscher ericholscher merged commit af77787 into main Dec 12, 2024
4 checks passed
@ericholscher ericholscher deleted the markdoc branch December 12, 2024 17:35
@ericholscher
Copy link
Member Author

ericholscher commented Dec 12, 2024

@humitos Sounds good. We should break out a roadmap card to track that work, and put it on the next sprint perhaps?

Edit: created #341

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.

2 participants