Skip to content

Commit e83e479

Browse files
committed
Update and reorganize the project roadmap in README.md:
- Introduce `Roadmap v0.1.0` and `Roadmap v0.2.0` sections.
1 parent 8e1b040 commit e83e479

File tree

1 file changed

+37
-20
lines changed

1 file changed

+37
-20
lines changed

README.md

Lines changed: 37 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,42 @@
44

55
---
66

7+
## 🎯 Roadmap
8+
9+
### Roadmap v0.1.0
10+
11+
- [x] Add initial `README` with project overview
12+
- [x] Add `ktlint` configuration for code style enforcement
13+
- [x] Integrate `Arrow Core` for exception handling
14+
- [x] Add `Kermit` logging library and replace println statements
15+
- [x] Configure GitHub Actions workflow
16+
- [x] Implement section-wise scroll behavior on the `Detail Screen` for better navigation
17+
- [x] Replace the search icon on the `Topic Card` to improve visual consistency
18+
- [x] Hide API key from code by using expect/actual for OpenAPI key
19+
- [x] Switch AI integration from OpenAI to Gemini
20+
- [x] Refactor network layer for cleaner architecture
21+
- [ ] Create a separate module for reusable UI components
22+
23+
---
24+
25+
### Roadmap v0.2.0
26+
27+
- [ ] Assign unique IDs to objects and enforce consistent ordering logic
28+
- [ ] Correct usage of visibility modifiers across the codebase
29+
- [ ] Introduce common `@Preview` annotations for reusable Composable previews
30+
- [ ] Add inline code formatting support for syntax display on the `Detail Screen`
31+
- [ ] Implement caching on the `Detail Screen` to store previously viewed topic data
32+
- [ ] Implement dynamic topic loading in `TopicRepository` to support scalability
33+
- [ ] Integrate Room database to persist bookmark states
34+
- [ ] Add a `Home Page` for navigation
35+
- [ ] Add a `Quiz Page` to host topic-based quizzes
36+
- [ ] Add a button in `DetailScreen` to attempt a quiz for that topic
37+
- [ ] Add a `Contributors Page` to showcase project contributors
38+
- [ ] Add a `Settings Page` with basic preferences
39+
- [ ] Implement a `Splash Screen`
40+
41+
---
42+
743
Kotlin Dictionary is a student-led, cross-platform app designed to help learners dive deep into the Kotlin programming language. It serves as an interactive reference where you can explore topics with clear explanations and reinforce your learning through quizzes.
844
_The data is powered by AI tools which help automate content generation, ensure consistency, and speed up the documentation._
945

@@ -49,23 +85,4 @@ Here are a couple of early previews from the Android version of the app:
4985

5086
## ⚠️ Disclaimer
5187

52-
This is an educational project developed by students. Expect rapid changes, experiments, and ongoing improvements as part of the learning journey. 😊
53-
54-
---
55-
56-
## 🎢 Roadmap
57-
58-
- [x] Add `ktlint` configuration for code style enforcement.
59-
- [x] Integrate `Arrow Core` for exception handling.
60-
- [x] Add a centralized logger.
61-
- [ ] Create a separate module for reusable UI components.
62-
- [x] Configure GitHub Actions workflow.
63-
- [ ] Assign unique IDs to objects and enforce consistent ordering logic.
64-
- [ ] Correct usage of visibility modifiers across the codebase.
65-
- [ ] Introduce common @Preview annotations for reusable Composable previews.
66-
- [ ] Implement section-wise scroll behavior on the `Detail Screen` for better navigation.
67-
- [ ] Add inline code formatting support for syntax display on the `Detail Screen`.
68-
- [x] Replace the search icon on the `Topic Card` to improve visual consistency.
69-
- [ ] Implement caching on the `Detail Screen` to store previously viewed topic data.
70-
- [x] Switch AI integration from OpenAI to Gemini.
71-
- [ ] Refactor network layer for cleaner architecture.
88+
This is an educational project developed by students. Expect rapid changes, experiments, and ongoing improvements as part of the learning journey. 😊

0 commit comments

Comments
 (0)