Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Ciphrox committed Feb 15, 2025
1 parent d42c8d8 commit aeee98e
Show file tree
Hide file tree
Showing 7 changed files with 24 additions and 7 deletions.
31 changes: 24 additions & 7 deletions docs/pages.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,48 +12,63 @@ This document describes the functionality and purpose of each page in the applic

### Blog Pages

- **Index** (/pages/blog/index.astro): Lists all blog posts in a grid layout
- **Blog Post** (/pages/blog/[slug].astro): Individual blog post template
- **Blog Card** (/pages/blog/BlogCard.astro): Reusable component for blog previews
- **Index** (/pages/blog/index.astro)
Lists all blog posts in a grid layout
- **Blog Post** (/pages/blog/[slug].astro)
Individual blog post template
- **Blog Card** (/pages/blog/BlogCard.astro)
Reusable component for blog previews

### Interactive Learning Pages

#### Varnmala Page (/pages/varnmala.astro)

![Varnmala page](../src/assets/screenshots/varnmala.png)

- Displays Hindi and English alphabets
- Uses Alphabet component to render letter lists
- Includes help section explaining the concept

#### Typing Page (/pages/typing.astro)

![Typing practice page](../src/assets/screenshots/typing.png)

- Interactive typing practice
- Shows letters, emojis, and spelling animations
- Responds to keyboard input (A-Z)
- Includes visual feedback

#### Reader Page (/pages/reader.astro)

![Reader page](../src/assets/screenshots/reader.png)

- Text-to-speech functionality
- Multiple speaker options (Mudra, Rutvi)
- Audio control for alphabet pronunciation
- Emoji display with letters

#### Panel Page (/pages/panel.astro)

![3D Panel page](../src/assets/screenshots/panel.png)

- 3D rotating letter panel
- Arrow key navigation
- Custom HTML element (letter-panel)
- Interactive letter display

#### Hindi Page (/pages/hindi.astro)
#### English Page (/pages/hindi.astro)

![English practice page](../src/assets/screenshots/english.png)

- Hindi alphabet practice
- English alphabet practice
- Color-changing letter display
- Keyboard interaction
- Visual feedback

#### Record Page (/pages/record.astro)

![Audio recording page](../src/assets/screenshots/record.png)

- Audio recording functionality
- Visualization of audio input
- Controls for record/pause/stop
Expand All @@ -68,8 +83,10 @@ This document describes the functionality and purpose of each page in the applic

### Legal Pages

- **Terms** (/pages/terms.astro): Terms and conditions page
- **Privacy** (/pages/privacy.astro): Privacy policy page
- **Terms** (/pages/terms.astro)
Terms and conditions page
- **Privacy** (/pages/privacy.astro)
Privacy policy page

## Common Features

Expand Down
Binary file added src/assets/screenshots/english.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/screenshots/panel.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/screenshots/reader.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/screenshots/record.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/screenshots/typing.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/screenshots/varnmala.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit aeee98e

Please sign in to comment.