diff --git a/README.md b/README.md index bc44966e2..37e08b2e2 100644 --- a/README.md +++ b/README.md @@ -109,13 +109,12 @@ 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. +**PyAutoFit** is built in the open by its users: everyone is welcome to ask questions, +share what they have made with it, and contribute. -Collaborators receive the latest **PyAutoFit** updates in the [Slack channel](https://pyautoFit.slack.com/). -Contact [James Nightingale](https://github.com/Jammy2211) about collaborator access. +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 new file mode 100644 index 000000000..3dab009ee --- /dev/null +++ b/docs/general/community.md @@ -0,0 +1,36 @@ +(community)= + +# Community + +**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. + +## Community contributions + +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. + +*No entries yet — be the first.* + +### Get listed + +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`). + +## Get help & talk to us + +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). + +## Contributing + +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) 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}