search

scribe-org / Scribe-Data

Wikidata, Wiktionary and Wikipedia language data extraction
GNU General Public License v3.0
30 stars 69 forks source link

Improve links to GitHub in documentation #91

Closed andrewtavis closed 8 months ago

andrewtavis commented 8 months ago

Terms

Description

One thing that would be great for Scribe-Data's documentation would be if the pages were linked to the page where the code was on GitHub rather than the page to edit the docs. I've seen this done for various projects. A Stack Overflow question on this topic that points to helpful docs can be found here.

Contribution

Happy to support someone who has interest in working on this!

mhmohona commented 8 months ago

I want to work on this issue.

mhmohona commented 8 months ago

@andrewtavis will you please explain the requirement bit more? We already have the code linked in doc file here, dont we?

andrewtavis commented 8 months ago

I can look for an example of this, @mhmohona. On some readthedocs documentation that I've seen the top right of the page isn't a link to the documentation that says Edit on GitHub, but rather a page to the code itself. So on the page for utils we'd see View code on GitHub or something like this, and then clicking it would go to utils.py on GitHub.

mhmohona commented 8 months ago

So in simple words, changing this text into View code on GitHub? image Thats it @andrewtavis? 😅

andrewtavis commented 8 months ago

Not quite, @mhmohona :) When you click that link you go to the file on GitHub that's for the docs. We want the link to go to the actual code file, so utils.py within src, not within docs.

mhmohona commented 8 months ago

Thank you for patiently explaining me about the issue @andrewtavis. 🙏 I have understood the requirement now.

So I have tried various ways but failing to link customize link (python code file's link) instead of doc link. It would really help if you could give me a reference project as you mentioned in issue description.

However, if I put code link like afkmc2 put, will it meet the purpose? https://afkmc2.readthedocs.io/en/latest/reference.html

codeIntrovert commented 8 months ago

Hi GSOC24 applicant here :) Looks like this issue is still not fixed, I will try fixing this and let you know how it goes. From the conversation above what I believe the problem is when user clicks on Edit On Github right now user is redirected to the Docs stored on github, rather user should be redirected to the code file it self, for example utils.py @andrewtavis

andrewtavis commented 8 months ago

Hi @codeIntrovert: this issue is already assigned to @mhmohona. Could I asked that you look for a different issue?

@mhmohona, having a link below the header would be enough to close this :) This is a great idea, thanks!