Update docs (#485)

Author: outdooracorn

README.md

@@ -6,10 +6,10 @@ The purposes and features of this repository are:
 - Update the references to code you want to build MediaWiki from
 - Download the code you want to build MediaWiki from
 - Store and then copy in the custom WBStack code
-- Adjust some MediawWiki code to load custom WBStack code
+- Adjust some MediaWiki code to load custom WBStack code
 - Build the Docker image from the code in the `dist` directory
 - Test the image
-- Build the image automatically on Github Actions platform then push it.
+- Build the image automatically on Github Actions platform then push it
 
 This ultimately repackages MediaWiki together with its extensions, skins, and the WBStack code into `dist` and `dist-persist` folders, then creates a new "application" with a much tighter external interface (particularly around configuration).
 

docs/build-scripts.md

@@ -14,7 +14,7 @@ This script will resync the `dist` directory.
 This is made up of a series of steps:
 
 - Empty the `dist` directory entirely
-- `pacman`: Retrieive and build MediaWiki code, remove any bloat files that are not needed
+- `pacman`: Retrieve and build MediaWiki code, remove any bloat files that are not needed
 - `sync_dist-persist.sh`: Sync the `dist-persist` directory into `dist` (Custom & extra wbstack hooks, config, and files)
 - `04-docker-compose`: Perform a composer install
 - `05-docker-entrypoint-overrides`: Add the WBStack shims to MediaWiki entrypoints
@@ -30,9 +30,10 @@ There is a GitHub Action [Workflow](../.github/workflows/wbstack.sync.check.yml)
 `wikiman` is a MediaWiki specific yaml generator for pacman.
 This needs to be run by developers when updating component versions in `wikiman.yaml`
 
+> [!NOTE]
 > In order to be able to run wikiman you need to create a GitHub token in a file called `/sync/.github`.
 > The token does not require any special permissions, and it does not matter if it's a `classic` or `fine-grained token (beta)` token.
-> You can generate a new token [here](https://github.com/settings/tokens/1118022750).
+> You can generate a new token [here](https://github.com/settings/personal-access-tokens).
 
 #### pacman
 `pacman` is a generic tool using yaml to fetch a series of codebases and place them on disk.
@@ -48,4 +49,5 @@ Example:
   - https://gerrit.wikimedia.org/r/changes/mediawiki%2Fextensions%2FWikibase~833742/revisions/15/patch?download
 ```
 
-**please note**: currently these will get overridden if `wikiman` is used to generate the file!
+> [!WARNING]
+> Currently patches will get overridden if `wikiman` is used to generate the `pacman.yaml` file!

docs/dev-environment.md

@@ -6,14 +6,14 @@ These are currently not using the real api but rather gets their settings from t
 
 The fake api is served by the [server.php](test/server.php) script and reads the corresponding [subdomain](data/WikiInfo-site1.json) from each request.
 
-
 ### Start the dev environment
 
 ```sh
 docker compose up --build
 ```
 
-> **_Note:_** It's important to include the `--build` flag after making any significant changes to `dist`. The `Dockerfile` contains important maintenance scripts (e.g., `rebuildLocalisationCache.php`) that will only run when the container image is rebuilt.
+> [!NOTE]
+> It's important to include the `--build` flag after making any significant changes to `dist`. The `Dockerfile` contains important maintenance scripts (e.g., `rebuildLocalisationCache.php`) that will only run when the container image is rebuilt.
 
 Wait until both sites are accessible: