Skip to content

Commit 09e434d

Browse files
authored
Merge pull request #177 from oanelson/main
Add intro text to overview pages. Closes #175
2 parents 13399b9 + 5c0e107 commit 09e434d

File tree

6 files changed

+8
-11
lines changed

6 files changed

+8
-11
lines changed

docs/about/disclaimer-and-open-source-policy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ This section covers our accessibility and open source policies. It also covers c
1111
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:
1212

1313
- **Alternative text for images.** Make sure all images have descriptive text.
14-
- **Strong color contrast: Maintain high contrast between foreground and background colors for readability.
14+
- **Strong color contrast**: Maintain high contrast between foreground and background colors for readability.
1515
- **Text resizing.** Allow users to adjust text sizes based on personal preferences.
1616
- **Proper use of headings.** Structure pages to ensure clear navigation for screen readers.
1717
- **Descriptive links.** Avoid ambiguous text like "Click here" or "More..." and instead using meaningful link descriptions.

docs/developer-documentation/building-your-application/available-scripts/index.mdx

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,14 @@ sidebar_position: 4
44

55
# Available Scripts
66

7-
{/* Write top text here */}
8-
7+
There are many CLI scripts available for RADFish projects. Learn more about them in this section.
98

109
```mdx-code-block
1110
import DocCardList from '@theme/DocCardList';
1211
1312
<DocCardList />
1413
```
1514

16-
{/* Write bottom text here */}
17-
1815
**`npm start`**
1916

2017
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.

docs/developer-documentation/building-your-application/index.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,7 @@ sidebar_position: 4
44

55
# Building Your Application
66

7-
{/* Write top text here */}
8-
7+
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.
98

109
```mdx-code-block
1110
import DocCardList from '@theme/DocCardList';

docs/developer-documentation/building-your-application/patterns/index.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,7 @@ sidebar_position: 3
44

55
# Patterns
66

7-
{/* Write top text here */}
8-
7+
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.
98

109
```mdx-code-block
1110
import DocCardList from '@theme/DocCardList';

docs/developer-documentation/concepts/concepts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,5 @@ Modern users expect apps to be responsive and reliable, even with limited intern
1212

1313
Designing apps for these users present unique challenges. To meet these challenges, RADFish developers should be familiar with several concepts:
1414

15-
* [Offline-First](https://nmfs-radfish.github.io/radfish/developer-documentation/concepts/offline-first) design prioritizes functionalatity even without internet connectivity.
15+
* [Offline-First](https://nmfs-radfish.github.io/radfish/developer-documentation/concepts/offline-first) design prioritizes functionality even without internet connectivity.
1616
* [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.

docs/developer-documentation/examples-and-templates/examples/index.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ sidebar_position: 1
44

55
# Examples
66

7-
{/* Write top text here */}
7+
Examples are small projects designed to demonstrate RADFish ecosystem. Templates are meant to be a clean starting point for a new RADFish project.
8+
9+
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).
810

911

1012
```mdx-code-block

0 commit comments

Comments
 (0)