Skip to content

docs: update workspace prose refs from README.rst to README.md #387

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.

Sign up for GitHub

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

Merged
Jammy2211 merged 1 commit into from
May 4, 2026
Merged

docs: update workspace prose refs from README.rst to README.md #387

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/general/configs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
**PyAutoGalaxy** uses a number of configuration files that customize the default behaviour of the non-linear searches,
visualization and other aspects of **PyAutoGalaxy**.

Descriptions of every configuration file and their input parameters are provided in the `README.rst` in
Descriptions of every configuration file and their input parameters are provided in the `README.md` in
the [config directory of the workspace](https://github.com/Jammy2211/autogalaxy_workspace/tree/release/config)

## Setup
Expand Down
4 changes: 2 additions & 2 deletions docs/general/workspace.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ when you installed **PyAutoGalaxy**. If you didn't, checkout the
[installation instructions](https://pyautogalaxy.readthedocs.io/en/latest/general/installation.html#installation-with-pip)
for how to downloaded and configure the workspace.

The `README.rst` files distributed throughout the workspace describe every folder and file, and specify if
The `README.md` files distributed throughout the workspace describe every folder and file, and specify if
examples are for beginner or advanced users.

New users should begin by checking out the following parts of the workspace.
Expand All @@ -30,7 +30,7 @@ Here, you'll find the configuration files which customize:
> - The behaviour of different (y,x) Cartesian grids used to perform lens calculations.
> - The generaltrue config which customizes other aspects of **PyAutoGalaxy**.

Descriptions of every configuration file and their input parameters are provided in the `README.rst` in
Descriptions of every configuration file and their input parameters are provided in the `README.md` in
the [config directory of the workspace](https://github.com/Jammy2211/autogalaxy_workspace/tree/release/config)

## Dataset
Expand Down
Loading