diff --git a/docs/about/disclaimer-and-open-source-policy.md b/docs/about/disclaimer-and-open-source-policy.md index c771734..e51888b 100644 --- a/docs/about/disclaimer-and-open-source-policy.md +++ b/docs/about/disclaimer-and-open-source-policy.md @@ -11,7 +11,7 @@ This section covers our accessibility and open source policies. It also covers c At RADFish, we're committed to ensuring that all users can fully engage with our project. We adhere to Section 508 of the Rehabilitation Act and the Web Content Accessibility Guidelines (WCAG 2.1) from the World Wide Web Consortium (W3C). Key accessibility features include: - **Alternative text for images.** Make sure all images have descriptive text. -- **Strong color contrast: Maintain high contrast between foreground and background colors for readability. +- **Strong color contrast**: Maintain high contrast between foreground and background colors for readability. - **Text resizing.** Allow users to adjust text sizes based on personal preferences. - **Proper use of headings.** Structure pages to ensure clear navigation for screen readers. - **Descriptive links.** Avoid ambiguous text like "Click here" or "More..." and instead using meaningful link descriptions. diff --git a/docs/developer-documentation/building-your-application/available-scripts/index.mdx b/docs/developer-documentation/building-your-application/available-scripts/index.mdx index a646d32..bc5ff40 100644 --- a/docs/developer-documentation/building-your-application/available-scripts/index.mdx +++ b/docs/developer-documentation/building-your-application/available-scripts/index.mdx @@ -4,8 +4,7 @@ sidebar_position: 4 # Available Scripts -{/* Write top text here */} - +There are many CLI scripts available for RADFish projects. Learn more about them in this section. ```mdx-code-block import DocCardList from '@theme/DocCardList'; @@ -13,8 +12,6 @@ import DocCardList from '@theme/DocCardList'; ``` -{/* Write bottom text here */} - **`npm start`** Starts the Vite development server. It runs the app locally with hot module reloading, allowing for fast development and instant updates as you make changes. Open [http://localhost:3000](http://localhost:3000/) to view it in the browser. diff --git a/docs/developer-documentation/building-your-application/index.mdx b/docs/developer-documentation/building-your-application/index.mdx index c1853e7..85849fd 100644 --- a/docs/developer-documentation/building-your-application/index.mdx +++ b/docs/developer-documentation/building-your-application/index.mdx @@ -4,8 +4,7 @@ sidebar_position: 4 # Building Your Application -{/* Write top text here */} - +Learn how to set up your project and make sure it meets development standards in this section. You can also learn about patterns and scripts that can help you build your application. ```mdx-code-block import DocCardList from '@theme/DocCardList'; diff --git a/docs/developer-documentation/building-your-application/patterns/index.mdx b/docs/developer-documentation/building-your-application/patterns/index.mdx index a23e670..90632b5 100644 --- a/docs/developer-documentation/building-your-application/patterns/index.mdx +++ b/docs/developer-documentation/building-your-application/patterns/index.mdx @@ -4,8 +4,7 @@ sidebar_position: 3 # Patterns -{/* Write top text here */} - +Patterns are solutions to common problems in software design. In this section, you can learn about several patterns that help with routing, state management, APIs, and other common components of RADFish applications. There are also patterns for testing, debugging, and other parts of the software development lifecycle. ```mdx-code-block import DocCardList from '@theme/DocCardList'; diff --git a/docs/developer-documentation/concepts/concepts.md b/docs/developer-documentation/concepts/concepts.md index 96b5b0d..b0009da 100644 --- a/docs/developer-documentation/concepts/concepts.md +++ b/docs/developer-documentation/concepts/concepts.md @@ -12,5 +12,5 @@ Modern users expect apps to be responsive and reliable, even with limited intern Designing apps for these users present unique challenges. To meet these challenges, RADFish developers should be familiar with several concepts: -* [Offline-First](https://nmfs-radfish.github.io/radfish/developer-documentation/concepts/offline-first) design prioritizes functionalatity even without internet connectivity. +* [Offline-First](https://nmfs-radfish.github.io/radfish/developer-documentation/concepts/offline-first) design prioritizes functionality even without internet connectivity. * [On-Device Storage](https://nmfs-radfish.github.io/radfish/developer-documentation/concepts/on-device-storage) is storing data directly on a user's device, without relying on internet connectivity. \ No newline at end of file diff --git a/docs/developer-documentation/examples-and-templates/examples/index.mdx b/docs/developer-documentation/examples-and-templates/examples/index.mdx index 9b962b0..6cd46a5 100644 --- a/docs/developer-documentation/examples-and-templates/examples/index.mdx +++ b/docs/developer-documentation/examples-and-templates/examples/index.mdx @@ -4,7 +4,9 @@ sidebar_position: 1 # Examples -{/* Write top text here */} +Examples are small projects designed to demonstrate RADFish ecosystem. Templates are meant to be a clean starting point for a new RADFish project. + +The source code for each example is in the open source repo for RADFish [boilerplate](https://github.com/NMFS-RADFish/boilerplate/tree/main/examples). Each example can be cloned and run separately as you are working with each from the RADFish CLI. To learn how to run these scripts, refer to the [running examples section](https://nmfs-radfish.github.io/radfish/developer-documentation/building-your-application/available-scripts/running-example). ```mdx-code-block