Skip to content

Commit 00a981a

Browse files
authored
Merge pull request #54 from LibreSign/chore/change-introduction-text
change introduction text
2 parents 0824f06 + beeb94b commit 00a981a

File tree

6 files changed

+82
-15
lines changed

6 files changed

+82
-15
lines changed

admin_manual/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Admin Manual
2-
=================
2+
============
33

44
Welcome to the user manual for the software. This documentation is designed to help you understand how to use the software effectively.
55

admin_manual/introduction.rst

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,27 @@ What is Libresign?
66

77
Libresign is a software package that provides a set of tools for working with digital signatures. It is designed to be easy to use and flexible, allowing you to integrate it into your own applications or use it as a standalone tool.
88

9-
Videos and blogs
10-
----------------
9+
About This Documentation
10+
------------------------
1111

12-
Visit our `blog <https://libresign.coop/posts/>`__
12+
This section is intended for LibreSign system administrators, who are responsible for installing, configuring, maintaining, and monitoring the application in test or production environments.
13+
14+
Here you will find:
15+
16+
- System requirements and installation instructions;
17+
18+
- Environment configuration, variables, and required services (e.g., database, containers, certificates);
19+
20+
- User and permission management;
1321

14-
Target audience
15-
---------------
22+
- Backup, update, and recovery procedures;
1623

17-
- Public sector
18-
- Education
19-
- Private companies
24+
- Best practices for security and system monitoring.
25+
26+
This documentation was designed to support those who ensure that LibreSign runs securely and efficiently.
27+
28+
29+
Blog
30+
----
31+
32+
Visit our `blog <https://libresign.coop/posts/>`__

developer_manual/index.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,10 @@ Here you will find the documentation for developers.
1616

1717

1818
.. toctree::
19-
:maxdepth: 1
19+
:maxdepth: 2
20+
:hidden:
2021

22+
introduction
2123
guide-api
2224
api
2325
code-of-conduct

developer_manual/introduction.rst

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
Introduction
2+
============
3+
4+
What is Libresign?
5+
------------------
6+
7+
Libresign is a software package that provides a set of tools for working with digital signatures. It is designed to be easy to use and flexible, allowing you to integrate it into your own applications or use it as a standalone tool.
8+
9+
About This Documentation
10+
------------------------
11+
12+
This section is intended for developers who want to understand the architecture of LibreSign, contribute to the codebase, or integrate the solution with other systems.
13+
14+
Here you will find:
15+
16+
- An overview of the project's architecture and core technologies;
17+
18+
- Instructions for setting up the development environment;
19+
20+
- Code standards, folder structure, and best practices adopted in the project;
21+
22+
- Detailed API documentation and usage examples;
23+
24+
Guidelines for contributing to the source code and submitting improvements.
25+
26+
Whether you're part of the team, an external contributor, or simply curious about how LibreSign works under the hood — this section is for you.
27+
28+
Blog
29+
----
30+
31+
Visit our `blog <https://libresign.coop/posts/>`__

main/index.rst

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,16 @@
33
Welcome to LibreSign documentation
44
==================================
55

6-
Chose one of the sections below to access the corresponding documentation:
6+
Welcome to the LibreSign documentation — a digital signature solution developed entirely with free and open-source software by a technology cooperative. This project aims to provide a secure, accessible, and transparent platform for digital document authentication and validation.
77

8-
- `User manual </user_manual/>`_
9-
- `Developer manual </developer_manual/>`_
10-
- `Admin manual </admin_manual/>`_
8+
This documentation is organized into sections tailored for different audiences:
9+
10+
- `User manual </user_manual/>`_ : instructions on how to use the system.
11+
- `Developer manual </developer_manual/>`_ : technical guides, APIs, and contribution guidelines.
12+
- `Admin manual </admin_manual/>`_ : guidance for installing, configuring, and maintaining the platform.
1113

1214

1315
Reporting Documentation Bugs & How to Contribute
14-
=================================================
16+
================================================
1517

1618
If you find an error or omission in any of the manuals, we welcome your bug reports and contributions. Contribution to the documentation is very easy as the code is entirely `on GitHub and can be edited there online <https://github.com/LibreSign/documentation/>`_.

user_manual/introduction.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,28 @@ What is Libresign?
66

77
Libresign is a software package that provides a set of tools for working with digital signatures. It is designed to be easy to use and flexible, allowing you to integrate it into your own applications or use it as a standalone tool.
88

9+
About This Documentation
10+
------------------------
11+
12+
This section is intended for LibreSign users — individuals who need to sign, validate, or track digital documents in a simple and secure way.
13+
14+
Here you will find:
15+
16+
- Step-by-step guides on how to use the main features of the system;
17+
- Explanations of the user interface, including screens and menu options;
18+
- Instructions for performing digital signatures, viewing documents, and tracking process status;
19+
- Tips and answers to frequently asked questions (FAQ).
20+
21+
No technical knowledge is required to use the system. This documentation was designed to be clear and accessible, even for those without a technology background.
22+
923
Target audience
1024
---------------
1125

1226
- Public sector
1327
- Education
1428
- Private companies
29+
30+
Blog
31+
----
32+
33+
Visit our `blog <https://libresign.coop/posts/>`__

0 commit comments

Comments
 (0)