Skip to content

Commit 1862f2f

Browse files
committed
Update README.md
1 parent 1f628be commit 1862f2f

File tree

1 file changed

+34
-5
lines changed

1 file changed

+34
-5
lines changed

README.md

Lines changed: 34 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ static assets using GitHub Actions and hosted by GitHub Pages.
1010
- [Markdown Syntax](#markdown-syntax)
1111
- [React Components](#react-components)
1212
- [Routing and Structure](#routing-and-structure)
13-
- [Images](#images)
13+
- [Assets](#assets)
1414
- [Hosting, Build, and Deployment](#hosting-build-and-deployment)
1515
- [Editing Rules & Guidelines](#editing-rules--guidelines)
1616
- [Blog](#blog)
@@ -142,17 +142,46 @@ I will implement this sometime in the future.
142142
Further information on routing and structure can be found in the
143143
[Next.js Docs](https://nextjs.org/docs/app/getting-started/project-structure).
144144

145-
## Images
145+
## Assets
146146

147-
TODO
147+
Assets (images, pdfs, etc.) should be placed in the `public/` folder. Assets for the Blog, Docs, and
148+
Gallery should be placed in their respective folders.
149+
150+
### Optimization
151+
152+
All images should be in SVG or WebP format if possible, in order to maintain low
153+
file size and fast load times. PDFs should be well compressed.
148154

149155
## Hosting, Build, and Deployment
150156

151-
TODO
157+
Next.js is currently configured to build the site into static assets. The build process happens
158+
using GitHub Actions. The artifact from the Actions workflow is then uploaded to GitHub pages.
159+
DNS configuration is handled by WSU, so updates to it must be made by opening a help ticket with
160+
WSU IT.
161+
162+
The Actions workflow is configured using [.github/workflows/nextjs.yml](./.github/workflows/nextjs.yml).
163+
please do not attempt to make changes to it without confirming with [@cole-wilson](https://github.com/cole-wilson) or
164+
[@asorge29](https://github.com/asorge29).
152165

153166
## Editing Rules & Guidelines
154167

155-
TODO
168+
### Edting Content
169+
170+
To make changes to the website's content, fork the repository, make a pull request,
171+
and request a review from [@cole-wilson](https://github.com/cole-wilson) or
172+
[@asorge29](https://github.com/asorge29).
173+
174+
### Requests and Issues
175+
176+
If you need changes to be made to the functionality of the website, find a bug, or
177+
need new custom React components for use on markdown pages,
178+
[open an issue](https://github.com/PalouseRobosub/website/issues), and we will get
179+
right on it.
180+
181+
### Code Contribution
182+
183+
If you have an idea for a large-scale change to the website, talk to an officer and
184+
fill out an approval form.
156185

157186
## Blog
158187

0 commit comments

Comments
 (0)