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.

Sign up for GitHub

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

Jump to bottom

Add GitHub Action to Check for Dead Links in Documentation #419

Open
2 tasks done
mhmohona opened this issue Oct 18, 2024 · 7 comments
Open
2 tasks done

Add GitHub Action to Check for Dead Links in Documentation #419

mhmohona opened this issue Oct 18, 2024 · 7 comments
Assignees
@Khushalsarode
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest Included as a part of Hacktoberfest Outreachy Available for Outreachy participants

Comments

@mhmohona
Copy link
Member

mhmohona commented Oct 18, 2024 •
edited
Loading

Terms

Description

We need a GitHub Action that automatically checks for dead links in Sphinx-generated documentation when changes are submitted (e.g., pull requests or pushes). This will ensure all links remain valid.

Contribution

Happy to support with answers to questions and reviewing a PR eventually 😊
@mhmohona mhmohona added documentation Improvements or additions to documentation good first issue Good for newcomers Outreachy Available for Outreachy participants hacktoberfest Included as a part of Hacktoberfest labels Oct 18, 2024
@Khushalsarode
Copy link
Contributor

shall I work on this?

@mhmohona
Copy link
Member Author

Please go ahead @Khushalsarode!

Khushalsarode added a commit to Khushalsarode/Scribe-Data that referenced this issue Oct 18, 2024
@Khushalsarode
scribe-org#419 Add GitHub Action to Check for Dead Links in Documenta…
5e622d8 
…tion
@Khushalsarode Khushalsarode mentioned this issue Oct 18, 2024
Closed
2 tasks
Khushalsarode added a commit to Khushalsarode/Scribe-Data that referenced this issue Oct 18, 2024
@Khushalsarode
scribe-org#419 Add GitHub Action to Check for Dead Links in Documenta…
3fd136b 
…tion
@Khushalsarode Khushalsarode mentioned this issue Oct 18, 2024
Closed
2 tasks
@rexbrown21
Copy link

Hi :) can i work on this?

@Khushalsarode Khushalsarode mentioned this issue Oct 28, 2024
Closed
2 tasks
@Khushalsarode
Copy link
Contributor

Created an python script that easy list the only broken link in formated manner
Like file location, link, broken status
Script includes regex to get only urls and can pass multiple file as parameters.
@andrewtavis
I will attach screen shots for preview.

@andrewtavis
Copy link
Member

Sounds interesting, @Khushalsarode :) Did you forget to attach the screenshot? Do you want to open a PR?

@Khushalsarode
Copy link
Contributor

Khushalsarode commented Nov 16, 2024 •
edited
Loading

Screenshot 2024-11-17 032635
Screenshot 2024-11-17 032614

need to pass file/folder as list of path ',' separated.
@andrewtavis

@andrewtavis
Copy link
Member

Can you open a PR with the code, @Khushalsarode?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Khushalsarode Khushalsarode

Labels
documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest Included as a part of Hacktoberfest Outreachy Available for Outreachy participants
Projects
Scribe Board
Status: Todo
Milestone
No milestone
Development

No branches or pull requests
4 participants
@mhmohona @andrewtavis @Khushalsarode @rexbrown21