Skip to content

docs: audit-driven URL fixes across docs, READMEs, and docstrings#309

Merged
Jammy2211 merged 1 commit into
mainfrom
feature/url-check
May 15, 2026
Merged

docs: audit-driven URL fixes across docs, READMEs, and docstrings#309
Jammy2211 merged 1 commit into
mainfrom
feature/url-check

Conversation

@Jammy2211

Copy link
Copy Markdown
Collaborator

Summary

Doc-only URL cleanup driven by the new admin_jammy/software/url_check/ audit tool (Jammy2211/admin_jammy#21). Fixes the user-reported hhttps:// typo in overview_2_new_user_guide.md plus ~20 mechanical URL rewrites covering:

  • Renamed GitHub orgs: Jammy2211/<workspace>PyAutoLabs/<workspace>; Jammy2211|rhayes777/<library>PyAutoLabs/<library>
  • Removed release branch on workspaces: /blob/release//blob/main/, /tree/release//tree/main/
  • nautilus sampler moved orgs: joshspeagle/nautilusjohannesulf/nautilus
  • PyAutoBuild moved orgs: rhayes777/PyAutoBuildPyAutoLabs/PyAutoBuild
  • Dead Code of Conduct links: bokeh CoC → /docs/CODE_OF_CONDUCT.md; numfocus → numfocus.org/code-of-conduct
  • Sphinx-doc: /en/main/en/master
  • pyautofit.readthedocs.io renames: cookbook_1_basicscookbooks/model, overview/model_fitoverview/the_basics, overview/resultcookbooks/result, etc.
  • Workspace notebook reorganisations: overview/simple/fit.ipynboverview/overview_1_the_basics.ipynb, modeling/imaging/features/<x>.ipynbimaging/features/<x>/modeling.ipynb, etc.
  • Colab badge URL: workspace-root start_here.ipynbnotebooks/<type>/start_here.ipynb (the bare-root file never existed)

No source-code behaviour changes — only docstring and .md / .rst / Python-comment text. CRLF line endings preserved (no whitespace churn).

Test plan

  • python -m pytest test_<library> passes
  • python -c "import <library>" succeeds (verifies docstring edits don't break parsing)
  • Audit re-run after this PR + paired PRs merge

Related

…in/, etc.)

Apply scripted URL rewrites surfaced by the new
admin_jammy/software/url_check/ audit tool. All changes are doc-only
(README, *.md, *.rst, plus docstring URLs in source files). No
behaviour changes. Line endings preserved.

Patterns applied:
- hhttps:// → https:// (user-reported typo in overview_2_new_user_guide.md)
- Jammy2211/<workspace> → PyAutoLabs/<workspace> (workspaces migrated orgs)
- Jammy2211|rhayes777/<library> → PyAutoLabs/<library>
- /blob/release/ and /tree/release/ → /main/ (release branch removed)
- joshspeagle/nautilus → johannesulf/nautilus (sampler moved orgs)
- rhayes777/PyAutoBuild → PyAutoLabs/PyAutoBuild
- bokeh CoC moved to /docs/CODE_OF_CONDUCT.md
- numfocus CoC moved to numfocus.org/code-of-conduct
- www.sphinx-doc.org /en/main → /en/master
- pyautofit.readthedocs.io renames (cookbook_1_basics → cookbooks/model,
  overview/model_fit → overview/the_basics, etc.)
- autofit_workspace overview/{simple,complex}/{fit,result}.ipynb → new flat structure
- workspaces modeling/imaging/features/<x>.ipynb → imaging/features/<x>/modeling.ipynb
- workspaces multi/modeling/features/<x>.ipynb → multi/features/<x>/modeling.ipynb
- workspaces multi/modeling/start_here.ipynb → multi/start_here.ipynb
- workspaces tree/main/notebooks/plot → notebooks/guides/plot
- Colab badge URL: workspace-root start_here.ipynb → notebooks/<type>/start_here.ipynb

Tool + report: PyAutoLabs/admin_jammy#21
Issue: PyAutoLabs/PyAutoLens#508

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

1 participant