Skip to content

Commit 2efa9d4

Browse files
committed
docs(README): update developer documentation section
- rename "Developer Document" to "Developer Wiki" - add details about AI-assisted Wiki - update link to new wiki location - improve wording and structure of documentation section - remove old doxygen documentation reference
1 parent 72778d0 commit 2efa9d4

1 file changed

Lines changed: 21 additions & 13 deletions

File tree

README.md

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ supports privacy and security for all.
3939
- [GpgFrontend](#gpgfrontend)
4040
- [Table of Contents](#table-of-contents)
4141
- [User Manual](#user-manual)
42-
- [Developer Document](#developer-document)
42+
- [Developer Wiki](#developer-wiki)
4343
- [Language Support](#language-support)
4444
- [Supported Languages](#supported-languages)
4545
- [Modules](#modules)
@@ -52,22 +52,30 @@ supports privacy and security for all.
5252

5353
## User Manual
5454

55-
GpgFrontend provides documentations on its main features. If you want to know
56-
how to install, please read the [User
57-
Manual](https://www.gpgfrontend.bktus.com/overview/glance) instead of README.
55+
For detailed instructions on installation, usage, and troubleshooting, please
56+
refer to the official [User
57+
Manual](https://www.gpgfrontend.bktus.com/overview/glance). The User Manual is
58+
the primary and most up-to-date resource for all users. It provides
59+
comprehensive guidance beyond what is found in the README, ensuring you have the
60+
latest information and best practices.
5861

59-
The code for the user manual is maintained in [this
60-
repository](https://github.com/saturneric/GpgFrontend-Manual.git).
62+
The source code for the user manual is maintained in this
63+
[repository](https://github.com/saturneric/GpgFrontend-Manual.git).
6164

62-
## Developer Document
65+
## Developer Wiki
6366

64-
You can view the developer documentations that is synchronized with the current
65-
latest develop code. [Developer Document](https://doxygen.gpgfrontend.bktus.com)
66-
will help you understand the source code and get involved more quickly in the
67-
process of contributing to open source.
67+
An AI-assisted Wiki has been generated through automated analysis of the
68+
GpgFrontend source code. This Wiki offers a comprehensive overview of the
69+
project’s technical architecture, design principles, and major components. The
70+
information provided is highly accurate, making it an excellent resource for
71+
both new and experienced contributors.
6872

69-
The code for the developer documentations is maintained in [this
70-
repository](https://github.com/saturneric/GpgFrontend-Doxygen.git).
73+
Link: https://deepwiki.com/saturneric/GpgFrontend
74+
75+
We strongly recommend reading the Wiki carefully before exploring the source
76+
code in depth. Gaining an understanding of the overall architecture and design
77+
principles in advance will significantly accelerate your learning process and
78+
enhance the quality of your contributions.
7179

7280
## Language Support
7381

0 commit comments

Comments
 (0)