Skip to content

Commit eecff84

Browse files
committed
Added readme docs for Pages
1 parent 37b8a5f commit eecff84

File tree

2 files changed

+82
-1
lines changed

2 files changed

+82
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Inside of your Astro project, you'll see the following folders and files:
2929
├── components.json
3030
├── docs
3131
│   ├── README.md
32-
│   └── state-management.md
32+
│   └── pages.md # Documentation for all pages and their functionality
3333
├── jsconfig.json
3434
├── LICENSE
3535
├── package.json

docs/pages.md

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
# Pages Documentation
2+
3+
This document describes the functionality and purpose of each page in the application.
4+
5+
## Main Pages
6+
7+
### About Page (/pages/about.astro)
8+
9+
- Simple about page explaining the purpose of the application
10+
- Contains a description of interactive games for kids
11+
- Includes help component explaining keyboard interaction
12+
13+
### Blog Pages
14+
15+
- **Index** (/pages/blog/index.astro): Lists all blog posts in a grid layout
16+
- **Blog Post** (/pages/blog/[slug].astro): Individual blog post template
17+
- **Blog Card** (/pages/blog/BlogCard.astro): Reusable component for blog previews
18+
19+
### Interactive Learning Pages
20+
21+
#### Varnmala Page (/pages/varnmala.astro)
22+
23+
- Displays Hindi and English alphabets
24+
- Uses Alphabet component to render letter lists
25+
- Includes help section explaining the concept
26+
27+
#### Typing Page (/pages/typing.astro)
28+
29+
- Interactive typing practice
30+
- Shows letters, emojis, and spelling animations
31+
- Responds to keyboard input (A-Z)
32+
- Includes visual feedback
33+
34+
#### Reader Page (/pages/reader.astro)
35+
36+
- Text-to-speech functionality
37+
- Multiple speaker options (Mudra, Rutvi)
38+
- Audio control for alphabet pronunciation
39+
- Emoji display with letters
40+
41+
#### Panel Page (/pages/panel.astro)
42+
43+
- 3D rotating letter panel
44+
- Arrow key navigation
45+
- Custom HTML element (letter-panel)
46+
- Interactive letter display
47+
48+
#### Hindi Page (/pages/hindi.astro)
49+
50+
- Hindi alphabet practice
51+
- Color-changing letter display
52+
- Keyboard interaction
53+
- Visual feedback
54+
55+
#### Record Page (/pages/record.astro)
56+
57+
- Audio recording functionality
58+
- Visualization of audio input
59+
- Controls for record/pause/stop
60+
- Clip management with naming and deletion
61+
62+
## Utility Pages
63+
64+
### Error Page (/pages/404.astro)
65+
66+
- Custom 404 error page
67+
- Simple navigation guidance
68+
69+
### Legal Pages
70+
71+
- **Terms** (/pages/terms.astro): Terms and conditions page
72+
- **Privacy** (/pages/privacy.astro): Privacy policy page
73+
74+
## Common Features
75+
76+
Most interactive pages include:
77+
78+
- Help component with instructions
79+
- Keyboard interaction
80+
- Visual feedback
81+
- Consistent layout using BaseLayout

0 commit comments

Comments
 (0)