Skip to content

Commit 1891a46

Browse files
Docs: Update Docs After v1.2.1 Release. (#11)
2 parents 8585acf + a2750d5 commit 1891a46

5 files changed

Lines changed: 163 additions & 30 deletions

File tree

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Database Migration Guide
2+
3+
this file give you a rough idea about how to draft/purpose a migration in atabse schema..
4+
5+
## Migration Rules / Migration Process
6+
7+
1. when you wanna change the database scheme, you have before time draft a new pr..
8+
9+
2. your new pr should draft a new dtabase scheme file, whn your pr merge in this docs repository. then only you can even write code in codebase releated to migration.
10+
11+
3. after, that code changes you have make two prs.. one in passcodes app repo and one in passcodes docs repo... this pr will we be merged together into both individuall repository at once..
12+
13+
**Summary**: `Pr-docs` -> `Code-changes` -> `Post-docs`
14+
15+
## Why Rules This Exists?
16+
17+
- [Migration Vidoe of Theo](https://youtu.be/jeWrbAiA1D0)
Lines changed: 34 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,47 @@
11
# Open Contributing Timeline
22

3-
This file will provide from when and where, the repository will be able to accept external contribution from other developers and community..
4-
This will provide you the abstract idea / timeline, that you can look at and see, how much you need to wait, to contribute,
3+
This file will provide from when and where, the repository will be able to accept external contribution from other developers and community..
4+
This will provide you the abstract idea / timeline, that you can look at and see, how much you need to wait, to contribute,
55
Besides, it help cordinate the contribution process.... Also, we aim to provide you a clear timeline... And lay a path forward..
66

7+
???+ Note
78

8-
> [!NOTE]
9-
> You can current still contribute to the repository, if you plan to do so... But just keep in mind that, while do so, you may feel like everything is behind you,
10-
> and fight against you.. and this will slow you down.. also expect, less streamline process and you also expect some of your time waste..
11-
>
12-
> But, I will try my best to help as much as possible, on our telegram community.. to get you start on working.. but just keep this document and this entire thing in mind...
9+
currently though, you can still contribute to the repository, if you plan to do so...
1310

11+
but just keep in mind that, while doing so, you will feel like everything is behind you,
12+
and fighting against you.. and this will slow you down significantly.. expect, a less streamline process and also expect some of your time being wasted..
13+
14+
but, I will try my best to help as much as possible, on our telegram community.. to get you start on working.. but just keep this document and this entire thing in your mind...
1415

1516
## Steps Required To Cordinate Open Contributing...
1617

17-
- [X] Obviously, Idea!! (Aug 1, 2024)
18+
Passcodes project has to go though this process to be ready for open source & for community contribution.
19+
20+
- [x] Obviously, Idea!! (Aug 1, 2024)
1821

19-
- [X] Setup Github Repository (Personal Account) (Aug 5, 2024)
22+
- [x] Setup Github Repository (Personal Account) (Aug 5, 2024)
2023

21-
- [X] Make Prototype Release aka Proof Of Concept (Aug 26, 2024)
24+
- [x] Make Prototype Release aka Proof Of Concept (Aug 26, 2024)
2225

23-
- [X] `JeelDobariya38/Password-Manager` -> `JeelDobariya38/Passcodes` & Community Standards For Repository. (Aug 1, 2025)
26+
- [x] `JeelDobariya38/Password-Manager` -> `JeelDobariya38/Passcodes` & Community Standards For Repository. (Aug 1, 2025)
2427

25-
> Somehow, it is exactly after year!! [#17](https://github.com/PasscodesApp/Passcodes/pull/17) I just realized while write this document..
28+
> Somehow, it is exactly after year!! [#17](https://github.com/PasscodesApp/Passcodes/pull/17) I just realized while write this document..
2629
27-
- [X] Migrate Codebase: `Java -> Kotlin` (Aug 1, 2025)
30+
- [x] Migrate Codebase: `Java -> Kotlin` (Aug 1, 2025)
2831

29-
- [X] First Stable Release (Aug 16, 2025)
32+
- [x] First Stable Release (Aug 16, 2025)
3033

31-
- [X] Offically Organization on Github [JeelDobariya38 -> PasscodesApp](https://github.com/PasscodesApp) (Aug 31, 2025)
34+
- [x] Offically Organization on Github [JeelDobariya38 -> PasscodesApp](https://github.com/PasscodesApp) (Aug 31, 2025)
3235

33-
- [ ] Improve Structure & Organization.. i.e segregate app code, docs and website into different stuff (end of sep 2025)
36+
- [x] Improve Structure & Organization.. i.e segregate app code, docs and website into different stuff (Sep 25, 2025)
3437

35-
- [ ] `MVC -> MVVM` architecture update.. i.e current is more like mvc we move to mvvm as it is an industry standard (end of oct 2025)
38+
- [x] `MVC -> MVVM -> MVI` architecture update.. (Nov 11, 2025)
39+
40+
- [x] Clean architecture (Dec 15, 2025)
3641

3742
- [ ] `XML -> Jetpack Compose` (end of nov 2025)
3843

39-
- [ ] Documentation Update (in entire december)
44+
- [ ] Documentation Update i.e, license... contributor guide... style guide etc...(in entire december)
4045

4146
- [ ] Plan for Google Developer Verification, i mean we will discuss about it. (in december how manage or cordinate with it)
4247

@@ -46,12 +51,13 @@ Besides, it help cordinate the contribution process.... Also, we aim to provide
4651

4752
### Semi Open To Contribute (start of jan 2026)
4853

49-
> [!IMPORTANT]
50-
> The Organisation is from this point, open to receive any contribution from any potential contributors..
51-
>
52-
> The reason, it is not fully open to contributing is solely because of this developer verification thing... the thing is I don't want anyone to waste there time contributing to this repository.. because, I might end up not make verification due to some or other reason... and this might result in waste of other developer waste of there valuable time.. because without verification the application might not be release as google wouldn't allow it to install on android devices....
53-
>
54-
> Other then this, or If this thing doesn't impact you in anyway then you count the repository as fuly open to contribute but just have note of it..
54+
!!! Warning
55+
56+
The Organisation is from this point, open to receive any contribution from any potential contributors..
57+
58+
The reason, it is not fully open to contributing is solely because of this developer verification thing... the thing is I don't want anyone to waste there time contributing to this repository.. because, I might end up not make verification due to some or other reason... and this might result in waste of other developer's valuable time.. because without verification the application might not be release as google wouldn't allow it to install on android devices....
59+
60+
Other then this, or If this thing doesn't impact you in anyway then you count the repository as fuly open to contribute but just have a note of it..
5561

5662
- [ ] Find Contributor, Also Review & Update The Contribution Workflow & Get Feedback. (end mar 2026)
5763

@@ -61,9 +67,8 @@ Besides, it help cordinate the contribution process.... Also, we aim to provide
6167

6268
---
6369

64-
### Open To Contribution
70+
### 😊😊 Open To Contribution 😊😊
71+
72+
Further improvements to contributing workflow will be driven by feedback and contributor's input...
6573

66-
> [!NOTE]
67-
> Further improvements to contributing workflow will driven by feedback and contributor input...
68-
>
69-
> As cordinating contribution is a contiguous process and not a task that can not be done...
74+
As cordinating contribution is a contiguous process and not a task that can not be done...

‎docs/user-docs/changelog.md‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,66 @@ and well documented in our release workflow docs.
2323

2424
---
2525

26+
## v1.2.1 - Alpha (Jan 31, 2026)
27+
28+
<details>
29+
<summary>View Internal Details</summary>
30+
31+
```
32+
Pacakage Name = "com.jeeldobariya.passcodes"
33+
Min Android = 8.0 (API level 26)
34+
Max Android = 14 (API level 34)
35+
Version Code = 4
36+
Version Name = "v1.2.1-Alpha"
37+
Master Database Version = "v1"
38+
```
39+
40+
</details>
41+
42+
### Fixed
43+
44+
- **Update Version Info**: update the version name and version code that, I forget last time in a rush of releasing a new version..
45+
46+
[Checkout Release](https://github.com/PasscodesApp/Passcodes/releases/tag/v1.2.1){:target="\_blank"}
47+
[Release Notes](release-notes/#v121-alpha-jan-31-2026)
48+
[Full Changelog](https://github.com/PasscodesApp/Passcodes/compare/v1.2.0...v1.2.1)
49+
50+
## v1.2.0 - Alpha (Jan 31, 2026) [YANKED RELEASE]
51+
52+
<details>
53+
<summary>View Internal Details</summary>
54+
55+
```
56+
Pacakage Name = "com.jeeldobariya.passcodes"
57+
Min Android = 8.0 (API level 26)
58+
Max Android = 14 (API level 34)
59+
Version Code = 3
60+
Version Name = "v1.1.2-Alpha"
61+
Master Database Version = "v1"
62+
```
63+
64+
</details>
65+
66+
!!! failure
67+
68+
This is yanked release.. cuz, I forget to update version name in hurry of releasing a new version.
69+
70+
Don't use this release (v1.2.0) in any case.... always prefer that release (v1.2.1) over this... because it will create confusion in bug reports like if you use this release and a bug occur... you will not be able to tell whether you are on previous release (v1.1.2) or this release (v1.2.0)... due to same version number in two different release....
71+
72+
### Added
73+
74+
#### Preview Features
75+
76+
- **Jetpack Compose (Preview Feature)**: made a jetpack compose UI that can be used for basic operation. [[@JeelDobariya38]](https://github.com/JeelDobariya38)
77+
78+
### Fixed
79+
80+
- **Mimetypes For Import Passwords**: fixed csv mimetypes for importing passswords feature for better experience with android file picker.. [[@JeelDobariya38]](https://github.com/JeelDobariya38)
81+
82+
[Checkout Release](https://github.com/PasscodesApp/Passcodes/releases/tag/v1.2.0){:target="\_blank"}
83+
[Release Notes](release-notes/#v120-alpha-jan-31-2026-yanked-release)
84+
[Full Changelog](https://github.com/PasscodesApp/Passcodes/compare/v1.1.2...v1.2.0)
85+
2686
## v1.1.2 - Alpha (Dec 15, 2025)
2787

2888
<details>

‎docs/user-docs/release-notes.md‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,57 @@ This release notes are more or less end-user oriented.
2121

2222
---
2323

24+
## v1.2.1 - Alpha (Jan 31, 2026)
25+
26+
```
27+
Pacakage Name = "com.jeeldobariya.passcodes"
28+
Min Android = 8.0 (API level 26)
29+
Max Android = 14 (API level 34)
30+
Version Code = 4
31+
Version Name = "v1.2.1-Alpha"
32+
Master Database Version = "v1"
33+
```
34+
35+
**`TL;DR`: Fix my mistake, by updating the version name that I forget last time....**
36+
37+
- Last time (v1.2.0), I forget to update the version so fix it and re-release instantly... (gotta a real-idea of how dangerous "publish" button on github is.... 😂😂😂😂😂)
38+
39+
[Checkout Release](https://github.com/PasscodesApp/Passcodes/releases/tag/v1.2.1){:target="\_blank"}
40+
[Changelog](changelog/#v121-alpha-jan-31-2026)
41+
[Full Changelog](https://github.com/PasscodesApp/Passcodes/compare/v1.2.0...v1.2.1)
42+
43+
## v1.2.0 - Alpha (Jan 31, 2026) [YANKED RELEASE]
44+
45+
```
46+
Pacakage Name = "com.jeeldobariya.passcodes"
47+
Min Android = 8.0 (API level 26)
48+
Max Android = 14 (API level 34)
49+
Version Code = 3
50+
Version Name = "v1.1.2-Alpha"
51+
Master Database Version = "v1"
52+
```
53+
54+
!!! failure
55+
56+
This is an [yanked release](installing/#explicitly-yanked-release-pure-trash) and should not be used by any user.
57+
The soley purpose of this release is, just for documenation & serves as a part of project's story...
58+
59+
This release is yanked cuz, I launch the app in hurry and forget to do something that need to be done... (forget to update version number)...
60+
Checkout the release on github for full details...
61+
62+
Don't use this release (v1.2.0) in any case.... always prefer that release (v1.2.1) over this... because it will create confusion in bug reports like if you use this release and a bug occur... you will not be able to tell whether you are on previous release (v1.1.2) or this release (v1.2.0)... due to same version number in two different release....
63+
64+
**`TL;DR`: Design a new jetpack compose preview ui.. | Improved performance...**
65+
66+
- App now has a basic new preview.. jetpack compose ui... that can be used instead of old ui...
67+
- App provide a toggle to switch between two layouts...
68+
- Improve file selection menu experience while importing passwords..
69+
- Perfomance optimization. (due to dependency updates.)
70+
71+
[Checkout Release](https://github.com/PasscodesApp/Passcodes/releases/tag/v1.2.0){:target="\_blank"}
72+
[Changelog](changelog/#v120-alpha-jan-31-2026-yanked-release)
73+
[Full Changelog](https://github.com/PasscodesApp/Passcodes/compare/v1.1.2...v1.2.0)
74+
2475
## v1.1.2 - Alpha (Dec 15, 2025)
2576

2677
```

‎zensical.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ repo_name = "PasscodesApp/Passcodes"
8282
[project.theme]
8383

8484
# change this to "classic" to use the traditional Material for MkDocs look.
85-
variant = "classic"
85+
variant = "modern"
8686

8787
# Zensical allows you to override specific blocks, partials, or whole
8888
# templates as well as to define your own templates. To do this, uncomment

0 commit comments

Comments
 (0)