Skip to content

[FIX] -- mkdocs repo links to correct GitHub organization. #289

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

Conversation

DhavalGojiya
Copy link
Contributor

@DhavalGojiya DhavalGojiya commented Jul 2, 2025

Fixes broken GitHub links in documentation

This PR updates the MkDocs configuration to point to the correct GitHub organization and repository.


🐞 What’s the issue?

Currently, issue and PR links in the documentation (e.g. changelog) incorrectly point to:

https://github.com/dsoftware-inc/django-tasks-scheduler

Instead of the correct repo:

https://github.com/django-commons/django-tasks-scheduler

This causes links like #273 to open under the wrong user/org, resulting in 404 errors.

🔗 You can see this in action on the public changelog here:
https://django-tasks-scheduler.readthedocs.io/en/stable/changelog/


🔧 What this PR changes

  • Updates repo_name and user in mkdocs.yml from dsoftware-incdjango-commons
  • Ensures all shorthand issue and PR links generate URLs pointing to the correct repository
  • Fixes broken links in the rendered documentation (e.g. changelog)

📸 Before (Broken Links)

django-tasks-scheduler-mkdocs-broken-link-ss-dhaval


✅ After (Fixed Links)

After this PR, clicking an issue reference like #273 will correctly open:

https://github.com/django-commons/django-tasks-scheduler/issues/273

📌 Next Steps

  • Merge this PR
  • Rebuild and deploy updated documentation via ReadTheDocs

Thanks!

- Updated `repo_name` and `user` in `mkdocs.yml` from `dsoftware-inc` to `django-commons`
- Ensures issue and PR links render correctly in the generated documentation
- Fixes broken GitHub links in changelog and other pages
@cunla cunla merged commit 3660f24 into django-commons:master Jul 2, 2025
19 checks passed
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