From b53d883a37c11a519e9b9192acee04c161b77019 Mon Sep 17 00:00:00 2001 From: Jammy2211 Date: Wed, 7 Oct 2026 10:32:44 +0100 Subject: [PATCH 1/2] docs: add Community page and merge README Community & Contributing section (#773) Co-Authored-By: Claude Fable 5.1 --- README.md | 8 +++--- docs/general/community.md | 51 +++++++++++++++++++++++++++++++++++++++ docs/index.md | 1 + 3 files changed, 56 insertions(+), 4 deletions(-) create mode 100644 docs/general/community.md diff --git a/README.md b/README.md index bc44966e2..e7f06fede 100644 --- a/README.md +++ b/README.md @@ -109,13 +109,13 @@ as I go. The assistant will answer questions about concepts, equations, code and results as you study, and help with notebook errors. Share the lecture link and section or the cell you are working on; you choose when to move on. -## Community & Support +## Community & Contributing Questions, help with your code or your analysis, and ideas: the [PyAutoLabs Discussions](https://github.com/orgs/PyAutoLabs/discussions). Bug reports with a reproducer (a snippet, the traceback, your versions): an issue on the library's tracker. The Slack is for collaborators, by -invitation. +invitation: contact [James Nightingale](https://github.com/Jammy2211) about collaborator access. -Collaborators receive the latest **PyAutoFit** updates in the [Slack channel](https://pyautoFit.slack.com/). -Contact [James Nightingale](https://github.com/Jammy2211) about collaborator access. +Community-built tools, tutorials and how to contribute are on the [**PyAutoFit** community page](https://pyautofit.readthedocs.io/en/latest/general/community.html). +Contribution guidelines: [CONTRIBUTING.md](https://github.com/PyAutoLabs/PyAutoFit/blob/main/CONTRIBUTING.md). diff --git a/docs/general/community.md b/docs/general/community.md new file mode 100644 index 000000000..91c51642c --- /dev/null +++ b/docs/general/community.md @@ -0,0 +1,51 @@ +(community)= + +# Community + +**PyAutoFit** is developed in the open, and this page is where the community meets it: getting help, contributing, and +the tools and material people have built on top of it. + +## Get help & talk to us + +Questions, help with your code or your analysis, and ideas go to the +[PyAutoLabs Discussions](https://github.com/orgs/PyAutoLabs/discussions). + +Bug reports with a reproducer (a snippet, the traceback, your versions) go to the +[**PyAutoFit** issue tracker](https://github.com/PyAutoLabs/PyAutoFit/issues). + +The Slack workspace is for collaborators, by invitation. Contact +[James Nightingale](https://github.com/Jammy2211) if you would like access. + +## Contributing + +Contributions are welcome. Before you start, read: + +- The [**PyAutoFit** contributing guide](https://github.com/PyAutoLabs/PyAutoFit/blob/main/CONTRIBUTING.md). +- The [PyAutoLabs organisation-wide contribution guide](https://github.com/PyAutoLabs/.github/blob/main/CONTRIBUTING.md). +- The [Code of Conduct](https://github.com/PyAutoLabs/.github/blob/main/CODE_OF_CONDUCT.md). +- The [AI policy](https://github.com/PyAutoLabs/PyAutoScientist/blob/main/AI_POLICY.md): AI-assisted contributions are + welcome under it. +- Workspace and tutorial notebooks: edit the `.py` scripts in the workspace `scripts` folders, not the notebooks. The + `# %%` marker alternates code and markdown cells, and the notebooks are regenerated from the scripts. + +If you would like hands-on help with a contribution, ask on the +[PyAutoLabs Discussions](https://github.com/orgs/PyAutoLabs/discussions). + +## Community contributions + +These are independent tools, tutorials, teaching material and the code behind papers that people have built on +**PyAutoFit**. They are maintained by their authors and are not endorsed, tested or supported by PyAutoLabs. Read each +project's own README and license before using it. + +### Get listed + +Post about your project in the [PyAutoLabs Discussions](https://github.com/orgs/PyAutoLabs/discussions) and the +maintainers will add it, or open a pull request editing this page (`docs/general/community.md`). + +No entries yet — be the first. + +## See also + +- [**PyAutoLens** community page](https://pyautolens.readthedocs.io/en/latest/general/community.html) +- [**PyAutoGalaxy** community page](https://pyautogalaxy.readthedocs.io/en/latest/general/community.html) +- The [PyAutoLabs front page](https://pyautolabs.github.io). diff --git a/docs/index.md b/docs/index.md index 061127a21..38c782545 100644 --- a/docs/index.md +++ b/docs/index.md @@ -132,6 +132,7 @@ general/roadmap general/software general/citations general/credits +general/community ``` ```{toctree} From 5cefe9cdef426ff1005a48de52ee11e049137959 Mon Sep 17 00:00:00 2001 From: Jammy2211 Date: Wed, 7 Oct 2026 10:46:22 +0100 Subject: [PATCH 2/2] docs: simplify Community & Contributing wording (#773) Co-Authored-By: Claude Opus 5.5 --- README.md | 15 ++++++------ docs/general/community.md | 51 ++++++++++++++------------------------- 2 files changed, 25 insertions(+), 41 deletions(-) diff --git a/README.md b/README.md index e7f06fede..37e08b2e2 100644 --- a/README.md +++ b/README.md @@ -111,11 +111,10 @@ notebook errors. Share the lecture link and section or the cell you are working ## Community & Contributing -Questions, help with your code or your analysis, and ideas: the -[PyAutoLabs Discussions](https://github.com/orgs/PyAutoLabs/discussions). -Bug reports with a reproducer (a snippet, the traceback, your versions): -an issue on the library's tracker. The Slack is for collaborators, by -invitation: contact [James Nightingale](https://github.com/Jammy2211) about collaborator access. - -Community-built tools, tutorials and how to contribute are on the [**PyAutoFit** community page](https://pyautofit.readthedocs.io/en/latest/general/community.html). -Contribution guidelines: [CONTRIBUTING.md](https://github.com/PyAutoLabs/PyAutoFit/blob/main/CONTRIBUTING.md). +**PyAutoFit** is built in the open by its users: everyone is welcome to ask questions, +share what they have made with it, and contribute. + +Questions, ideas and bug reports: the [PyAutoLabs Discussions](https://github.com/orgs/PyAutoLabs/discussions). +Chat with us on [Slack](https://join.slack.com/t/pyautolens/shared_invite/zt-2cufp4eyf-fXfgMxRGuvg~bMrI3uOAxg). + +Community-built tools and tutorials, and how to contribute: the [**PyAutoFit** community page](https://pyautofit.readthedocs.io/en/latest/general/community.html). diff --git a/docs/general/community.md b/docs/general/community.md index 91c51642c..3dab009ee 100644 --- a/docs/general/community.md +++ b/docs/general/community.md @@ -2,50 +2,35 @@ # Community -**PyAutoFit** is developed in the open, and this page is where the community meets it: getting help, contributing, and -the tools and material people have built on top of it. +**PyAutoFit** is built in the open by its users: everyone is welcome to ask questions, share what they have made with +it, and contribute. This page lists what the community has built on **PyAutoFit**, how to get help and how to contribute. -## Get help & talk to us - -Questions, help with your code or your analysis, and ideas go to the -[PyAutoLabs Discussions](https://github.com/orgs/PyAutoLabs/discussions). - -Bug reports with a reproducer (a snippet, the traceback, your versions) go to the -[**PyAutoFit** issue tracker](https://github.com/PyAutoLabs/PyAutoFit/issues). - -The Slack workspace is for collaborators, by invitation. Contact -[James Nightingale](https://github.com/Jammy2211) if you would like access. - -## Contributing +## Community contributions -Contributions are welcome. Before you start, read: +Independent tools, tutorials, teaching material and the code behind papers built on **PyAutoFit**. They are maintained +by their authors and are not endorsed, tested or supported by PyAutoLabs; check each project's README and license. -- The [**PyAutoFit** contributing guide](https://github.com/PyAutoLabs/PyAutoFit/blob/main/CONTRIBUTING.md). -- The [PyAutoLabs organisation-wide contribution guide](https://github.com/PyAutoLabs/.github/blob/main/CONTRIBUTING.md). -- The [Code of Conduct](https://github.com/PyAutoLabs/.github/blob/main/CODE_OF_CONDUCT.md). -- The [AI policy](https://github.com/PyAutoLabs/PyAutoScientist/blob/main/AI_POLICY.md): AI-assisted contributions are - welcome under it. -- Workspace and tutorial notebooks: edit the `.py` scripts in the workspace `scripts` folders, not the notebooks. The - `# %%` marker alternates code and markdown cells, and the notebooks are regenerated from the scripts. +*No entries yet — be the first.* -If you would like hands-on help with a contribution, ask on the -[PyAutoLabs Discussions](https://github.com/orgs/PyAutoLabs/discussions). +### Get listed -## Community contributions +Post your project in the [PyAutoLabs Discussions](https://github.com/orgs/PyAutoLabs/discussions) (Show and tell) and the maintainers will add it, or open a +pull request editing this page (`docs/general/community.md`). -These are independent tools, tutorials, teaching material and the code behind papers that people have built on -**PyAutoFit**. They are maintained by their authors and are not endorsed, tested or supported by PyAutoLabs. Read each -project's own README and license before using it. +## Get help & talk to us -### Get listed +Questions, ideas and bug reports go to the [PyAutoLabs Discussions](https://github.com/orgs/PyAutoLabs/discussions). Chat with the developers and other users +on [Slack](https://join.slack.com/t/pyautolens/shared_invite/zt-2cufp4eyf-fXfgMxRGuvg~bMrI3uOAxg). -Post about your project in the [PyAutoLabs Discussions](https://github.com/orgs/PyAutoLabs/discussions) and the -maintainers will add it, or open a pull request editing this page (`docs/general/community.md`). +## Contributing -No entries yet — be the first. +Read the [PyAutoLabs contribution guide](https://github.com/PyAutoLabs/.github/blob/main/CONTRIBUTING.md) (one guide for every repository), the [Code of Conduct](https://github.com/PyAutoLabs/.github/blob/main/CODE_OF_CONDUCT.md) and the +[AI policy](https://github.com/PyAutoLabs/PyAutoScientist/blob/main/AI_POLICY.md) (AI-assisted contributions are welcome under it). Tutorial notebooks are generated from the `.py` +scripts in each workspace `scripts` folder, so edit those (the `# %%` marker alternates code and markdown cells), not +the notebooks. For hands-on help with a contribution, ask on the [PyAutoLabs Discussions](https://github.com/orgs/PyAutoLabs/discussions). ## See also - [**PyAutoLens** community page](https://pyautolens.readthedocs.io/en/latest/general/community.html) - [**PyAutoGalaxy** community page](https://pyautogalaxy.readthedocs.io/en/latest/general/community.html) -- The [PyAutoLabs front page](https://pyautolabs.github.io). +- The [PyAutoLabs front page](https://pyautolabs.github.io)