Skip to content

Commit

Permalink
Update general-info.md
Browse files Browse the repository at this point in the history
  • Loading branch information
SassafrasAU authored Sep 25, 2024
1 parent 3718755 commit f584239
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/documentation-maintenance/general-info.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ needed to get you going with the platform.
Below is a general list of points with useful stuff. If you come across any issues not listed here, feel free to reach out to me (Kaleb) through Ben Stephens.

## General
- This platform is based on Docusaurus. They have some amazing documnetation (here)[https://docusaurus.io/docs]. Especially their plugins, lots of good future improvements to the site there.
- This platform is based on Docusaurus. They have some amazing documnetation [here](https://docusaurus.io/docs). Especially their plugins, lots of good future improvements to the site there.
- If for whatever reason you need to manually deploy the site (as in the auto-deployment is not working). Open Git Bash to the location of the repo, and type `GIT_USER=<YOUR USERNAME> yarn deploy`. This needs to be done by an admin of the repo.
- Try and ensure that students have decent names for their files and pages.
- Ensure that proper file structure is followed (see tutorials for info).
Expand All @@ -23,7 +23,7 @@ Given pages are typically reviewed in the PR stage, most errors will be found du
Unexpected character `/` (U+002F) before local name, expected a character that can start a name, such as a letter, `$`, or `_` (note: to create a link in MDX, use `[text](url)`)
```

This is a URL not formatted properly. Ensure it is either using markdown `(text)[url]` or in plain text. This sometimes occurs when code blocks have not been used on code.
This is a URL not formatted properly. Ensure it is either using markdown `[text](url)` or in plain text. This sometimes occurs when code blocks have not been used on code.

---

Expand Down

0 comments on commit f584239

Please sign in to comment.