Skip to content

Minor changes to ReadME #338

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

Open
mpaqu-lib wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Minor changes to ReadME #338

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f65194d
Update README.md
mpaqu-lib May 18, 2026
662e61c
Merge pull request #1 from mpaqu-lib/mpaqu-lib-patch-1
mpaqu-lib May 18, 2026
c442e09
Update README.md
mpaqu-lib May 18, 2026
e2795aa
Update README.md
mpaqu-lib May 18, 2026
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
7 changes: 5 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ information as possible.
#### Fork & create a branch

When you are ready to start working on an issue, please assign it to yourself
as an indication that you are working on it. Then [fork TechDocs][https://github.com/archivesspace/tech-docs/fork] and
as an indication that you are working on it. Then [fork TechDocs](https://github.com/archivesspace/tech-docs/fork) and
create a branch with a descriptive name.

A good branch name would include the ticket number in it. For example, if you
Expand Down Expand Up @@ -115,6 +115,9 @@ Before making a pull request, make sure tests run successfully and code adheres
npm run prettier:fix
npm run stylelint:fix
```
#### Sidebar navigation updates

The sidebar navigation is not populated automatically, but by [src/siteNavigation.json](https://github.com/archivesspace/tech-docs/blob/main/src/siteNavigation.json). If you've made any changes to filenames (or addition/deletion of pages), be sure to update there as well for them to be reflected on the site.

#### Make a Pull Request

Expand All @@ -135,7 +138,7 @@ git rebase main
git push --set-upstream origin TD-123-descriptive-short-title
```

Finally, go to GitHub and [make a Pull Request][https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request] :D
Finally, go to GitHub and [make a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) :D

Our CI process will run all test suites against the pushed branch. We care about
quality, so your Pull Request won't be merged until all test suites pass. If any linting checks fail, the PR reviewer can fix those issues.
Expand Down
Loading