maint: remove developer instruction pages, update contribute links to project repos#201
Open
maint: remove developer instruction pages, update contribute links to project repos#201
Conversation
Developer instructions for QuantEcon.py and QuantEcon.jl have been migrated to the respective project repositories (see QuantEcon.py#740). This removes the now-redundant pages from the website and updates the 'Contribute' buttons to link directly to the CONTRIBUTING.md in each project repo. Deleted pages (all had menu_item: false, none in nav): - pages/python-developers.md (/python-developers/) - pages/julia-developers.md (/julia-developers/) - pages/developer-resources.md (/developer-resources/) - pages/wiki.md (/wiki/) - pages/wiki-py-conda-dev-env.md - pages/wiki-py-docstrings.md - pages/wiki-py-unit-testing.md Updated inbound links: - quantecon-py.md: Contribute button → QuantEcon.py CONTRIBUTING.md - quantecon-jl.md: Contribute button → QuantEcon.jl CONTRIBUTING.md Closes #126
✅ Deploy Preview for grand-swan-ca5201 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR continues the website cleanup by removing developer-instruction/wiki pages that have been migrated to the QuantEcon.py / QuantEcon.jl project repositories, and by repointing the “Contribute” calls-to-action on the library pages to the projects’ CONTRIBUTING.md.
Changes:
- Removes 7 now-redundant internal developer instruction / wiki pages from
pages/. - Updates the “Contribute” button links on the QuantEcon.py and QuantEcon.jl library pages to point to the corresponding GitHub
CONTRIBUTING.md.
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| pages/wiki.md | Removes the site “Wiki” index page (developer-only content). |
| pages/wiki-py-unit-testing.md | Removes Python unit testing instructions (migrated to project repo). |
| pages/wiki-py-docstrings.md | Removes Python docstring/documentation guidance (migrated to project repo). |
| pages/wiki-py-conda-dev-env.md | Removes Conda dev environment setup instructions (migrated to project repo). |
| pages/python-developers.md | Removes QuantEcon.py contribution instructions page (now redundant). |
| pages/julia-developers.md | Removes QuantEcon.jl contribution instructions page (now redundant). |
| pages/developer-resources.md | Removes developer resources hub page (now redundant). |
| pages/quantecon-py.md | Updates “Contribute” button to link directly to QuantEcon.py CONTRIBUTING.md on GitHub. |
| pages/quantecon-jl.md | Updates “Contribute” button to link directly to QuantEcon.jl CONTRIBUTING.md on GitHub. |
Comment on lines
+24
to
+25
| <p><a href="https://github.com/QuantEcon/QuantEcon.py/blob/master/CONTRIBUTING.md"><img alt=" " src="/assets/img/library-button-contribute.png"></a></p> | ||
| <p><a href="https://github.com/QuantEcon/QuantEcon.py/blob/master/CONTRIBUTING.md">Contribute</a></p> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Completes the cleanup step from #126. Developer instructions for
QuantEcon.pyandQuantEcon.jlwere already migrated to the respective project repositories (QuantEcon.py#740). This PR removes the now-redundant pages from the website.Deleted pages
All 7 pages had
menu_item: falseand were not in the site navigation:pages/python-developers.md/python-developers/pages/julia-developers.md/julia-developers/pages/developer-resources.md/developer-resources/pages/wiki.md/wiki/pages/wiki-py-conda-dev-env.md/wiki-py-conda-dev-env/pages/wiki-py-docstrings.md/wiki-py-docstrings/pages/wiki-py-unit-testing.md/wiki-py-unit-testing/Updated links
The "Contribute" buttons on the code library pages previously linked to the now-deleted internal pages. They now point directly to
CONTRIBUTING.mdin each project repo:pages/quantecon-py.md→https://github.com/QuantEcon/QuantEcon.py/blob/master/CONTRIBUTING.mdpages/quantecon-jl.md→https://github.com/QuantEcon/QuantEcon.jl/blob/master/CONTRIBUTING.mdVerified
bundle exec jekyll buildpasses cleanly with no broken referencesCloses #126