Fix page navigation (#1065)

* fix navigation * fix links * move usability to non-functional requirements * fix links
microsoft · Aug 22, 2024 · a4bedca · a4bedca
1 parent 6a77040
commit a4bedca
Show file tree

Hide file tree

Showing 11 changed files with 8 additions and 39 deletions.
diff --git a/docs/.pages b/docs/.pages
@@ -3,7 +3,9 @@ nav:
   - Engineering Fundamentals Checklist: engineering-fundamentals-checklist.md
   - The First Week of an ISE Project: the-first-week-of-an-ise-project.md
   - Who is ISE?: ISE.md
+  - Contributing: contributing.md
   - Agile Development: agile-development
   - Automated Testing: automated-testing
   - CI/CD: CI-CD
   - ...
+  - UI/UX: UI-UX
diff --git a/docs/CI-CD/.pages b/docs/CI-CD/.pages
diff --git a/docs/resources/templates/LICENSE → docs/LICENSE b/docs/resources/templates/LICENSE → docs/LICENSE
diff --git a/docs/user-interface-engineering/README.md → docs/UI-UX/README.md b/docs/user-interface-engineering/README.md → docs/UI-UX/README.md
@@ -12,10 +12,10 @@ Keep in mind that like all software, there is no "right way" to build a user int
 
 The state of web platform engineering is fast moving. There is no one-size-fits-all solution. For any team to be successful in building a UI, they need to have an understanding of the higher-level aspects of all UI project.
 
-1. [**Accessibility**](../accessibility/README.md) - ensuring your application is usable and enjoyed by as many people as possible is at the heart of accessibility and inclusive design.
-1. [**Usability**](./usability.md) - how effortless should it be for any given user to use the application? Do they need special training or a document to understand how to use it, or will it be intuitive?
+1. [**Accessibility**](../non-functional-requirements/accessibility.md) - ensuring your application is usable and enjoyed by as many people as possible is at the heart of accessibility and inclusive design.
+1. [**Usability**](../non-functional-requirements/usability.md) - how effortless should it be for any given user to use the application? Do they need special training or a document to understand how to use it, or will it be intuitive?
 1. [**Maintainability**](../non-functional-requirements/maintainability.md) - is the application just a proof of concept to showcase an idea for future work, or will it be an MVP and act as the starting point for a larger, production-ready application? Sometimes you don't need React or any other framework. Sometimes you need React, but not all the bells and whistles from create-react-app. Understanding project maintainability requirements can simplify an engagement’s tooling needs significantly and let folks iterate without headaches.
-1. [**Stability**](./stability.md) - what is the cost of adding a dependency? Is it actively stable/updated/maintained? If not, can you afford the tech debt (sometimes the answer can be yes!)? Could you get 90% of the way there without adding another dependency?
+1. **Stability** - what is the cost of adding a dependency? Is it actively stable/updated/maintained? If not, can you afford the tech debt (sometimes the answer can be yes!)? Could you get 90% of the way there without adding another dependency?
 
 More information is available for each general guidance section in the corresponding pages.
 

diff --git a/...e-engineering/recommended-technologies.md → docs/UI-UX/recommended-technologies.md b/...e-engineering/recommended-technologies.md → docs/UI-UX/recommended-technologies.md
@@ -48,11 +48,3 @@ npm init vite@latest my-app --template react-ts
 # npm 7.x
 npm init vite@latest my-app -- --template react-ts
 ```
-
-## HTML/CSS/JS
-
-> Coming soon!
-
-## Web Components
-
-> Coming soon!
diff --git a/docs/resources/templates/CONTRIBUTING.md → docs/contributing.md b/docs/resources/templates/CONTRIBUTING.md → docs/contributing.md
diff --git a/docs/user-interface-engineering/usability.md → .../non-functional-requirements/usability.md b/docs/user-interface-engineering/usability.md → .../non-functional-requirements/usability.md
@@ -2,7 +2,7 @@
 
 Usability is a topic that is often used interchangeably with user experience (UX), but they are not the same thing. Usability is a subset of UX, focusing specifically on the ease of use and effectiveness of a product, i.e., it is the ease with which users can learn and use a product to achieve their goals. Usability is a key factor in determining the success of a product, as it directly impacts user satisfaction, productivity, and overall experience. A system that is difficult to use or understand can lead to frustration, errors, and ultimately, abandonment by users.
 
-Closely coupled with usability and UX is the concept of accessibility, which you can read more about [here](../accessibility/README.md).
+Closely coupled with usability and UX is the concept of [accessibility](./accessibility.md).
 
 ## Characteristics
 

diff --git a/docs/resources/ms_icon.png b/docs/resources/ms_icon.png
diff --git a/docs/resources/templates/README.md b/docs/resources/templates/README.md
diff --git a/docs/user-interface-engineering/stability.md b/docs/user-interface-engineering/stability.md
diff --git a/linkcheck.json b/linkcheck.json
@@ -67,7 +67,8 @@
       "https://www.onetrust.com/blog/principles-of-privacy-by-design/",
       "https://docs.github.com/en/rest/commits/statuses",
       "https://blog.twitter.com/engineering/en_us/a/2015/diffy-testing-services-without-writing-tests.html",
-      "https://blog.github.com/2012-09-17-contributing-guidelines/"
+      "https://blog.github.com/2012-09-17-contributing-guidelines/",
+      "https://www.fast.design/docs/integrations/react"
     ],
     "only_errors": true,
     "cache_duration": "24h",