Skip to content
This repository was archived by the owner on Apr 9, 2025. It is now read-only.

Make the page easy to comprehend #333

Closed
wants to merge 1 commit into from

Conversation

network-charles
Copy link

@network-charles network-charles commented Mar 12, 2025

  • The word "development" used in this sentence, "This is a very small guide to help with the development of this extension." made me think that this page was focused on contributors who are interested in improving the features of this extension. It wasn't until someone told me that the page is focused on how to test the extension in my development environment. I've updated the word.
  • I also changed "existent" to an easier word, "existing".
  • In this sentence, "The project and version has" project and version are two nouns, so using the verb "has" is wrong.
  • I updated the link to installing Read the Docs locally to the latest URL.

📚 Documentation preview 📚: https://sphinx-hoverxref--333.org.readthedocs.build/en/333/

@network-charles network-charles requested a review from a team as a code owner March 12, 2025 12:16
@network-charles network-charles force-pushed the patch-1 branch 2 times, most recently from 9426125 to 52fd2b0 Compare March 12, 2025 12:57
@humitos
Copy link
Member

humitos commented Mar 13, 2025

Hi! Thanks for your collaboration. We are not spending too much time in this extension anymore since it was integrated directly into the product as "Links preview": https://docs.readthedocs.com/platform/stable/link-previews.html

Now, it works for any documentation tool, not just Sphinx.

Due to this, we plan to archive this repository soon.

@network-charles
Copy link
Author

Oh, nice! Thanks for the clarification.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants