From f65194dac73592e4f7f9602fa811d94efb468708 Mon Sep 17 00:00:00 2001 From: mpaqu-lib <44206597+mpaqu-lib@users.noreply.github.com> Date: Mon, 18 May 2026 09:47:20 -0400 Subject: [PATCH 1/3] Update README.md Added information about sidebar navigation --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 2f1a7dc..0903543 100644 --- a/README.md +++ b/README.md @@ -96,6 +96,10 @@ are working on JIRA ticket TD-123: git checkout -b TD-123-descriptive-short-title ``` +#### Sidebar navigation updates + +The sidebar navigation is not populated automatically, but by src/siteNavigation.json. Any changes to filenames (or addition/deletion of pages) must be updated there to be reflected on the site. + #### Get the test suite running Before running any tests, you will need to set up your environment. See [Running TechDocs locally](#running-techdocs-locally). From c442e09a96c16a5204c91a404480fb9d5ab4c8a2 Mon Sep 17 00:00:00 2001 From: mpaqu-lib <44206597+mpaqu-lib@users.noreply.github.com> Date: Mon, 18 May 2026 09:56:22 -0400 Subject: [PATCH 2/3] Update README.md --- README.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 0903543..9035685 100644 --- a/README.md +++ b/README.md @@ -96,10 +96,6 @@ are working on JIRA ticket TD-123: git checkout -b TD-123-descriptive-short-title ``` -#### Sidebar navigation updates - -The sidebar navigation is not populated automatically, but by src/siteNavigation.json. Any changes to filenames (or addition/deletion of pages) must be updated there to be reflected on the site. - #### Get the test suite running Before running any tests, you will need to set up your environment. See [Running TechDocs locally](#running-techdocs-locally). @@ -119,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 @@ -139,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. From e2795aab87fb3d4b9a36a268f8b482fe8029923e Mon Sep 17 00:00:00 2001 From: mpaqu-lib <44206597+mpaqu-lib@users.noreply.github.com> Date: Mon, 18 May 2026 10:30:42 -0400 Subject: [PATCH 3/3] Update README.md Fixed formatting of link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9035685..dffa606 100644 --- a/README.md +++ b/README.md @@ -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