Skip to content

Commit 979d14b

Browse files
authored
Merge pull request #55 from LibreSign/chore/remove-introduction-file
delete introduction file
2 parents 00a981a + 8061e35 commit 979d14b

File tree

6 files changed

+101
-105
lines changed

6 files changed

+101
-105
lines changed

admin_manual/index.rst

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,45 @@
11
Admin Manual
22
============
33

4-
Welcome to the user manual for the software. This documentation is designed to help you understand how to use the software effectively.
4+
Welcome to the admin manual for the software. This documentation is designed to help you understand how to use the software effectively.
5+
6+
Introduction
7+
============
8+
9+
What is Libresign?
10+
------------------
11+
12+
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.
13+
14+
About This Documentation
15+
------------------------
16+
17+
This section is intended for LibreSign system administrators, who are responsible for installing, configuring, maintaining, and monitoring the application in test or production environments.
18+
19+
Here you will find:
20+
21+
- System requirements and installation instructions;
22+
23+
- Environment configuration, variables, and required services (e.g., database, containers, certificates);
24+
25+
- User and permission management;
26+
27+
- Backup, update, and recovery procedures;
28+
29+
- Best practices for security and system monitoring.
30+
31+
This documentation was designed to support those who ensure that LibreSign runs securely and efficiently.
32+
33+
34+
Blog
35+
----
36+
37+
Visit our `blog <https://libresign.coop/posts/>`__
538

639
.. toctree::
740
:maxdepth: 2
841
:hidden:
942

10-
introduction
1143
installation
1244
configuration
1345
maintenance

admin_manual/introduction.rst

Lines changed: 0 additions & 32 deletions
This file was deleted.

developer_manual/index.rst

Lines changed: 34 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
.. _dev-index:
22

3-
Developer
4-
=========
5-
6-
Welcome
3+
Developer Manual
4+
================
75

86
We really appreciate everyone who would like to contribute to the LibreSign project! There are many ways to contribute, including writing code, filing issues on GitHub, helping people, assisting in triaging, reproducing, or fixing bugs that people have filed, and enhancing our documentation. Also giving a star to the project is a really good way to help and donate.
97

@@ -14,12 +12,43 @@ Before you get started, we encourage you to read our code of conduct, which desc
1412

1513
Here you will find the documentation for developers.
1614

15+
Introduction
16+
============
17+
18+
What is Libresign?
19+
------------------
20+
21+
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.
22+
23+
About This Documentation
24+
------------------------
25+
26+
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.
27+
28+
Here you will find:
29+
30+
- An overview of the project's architecture and core technologies;
31+
32+
- Instructions for setting up the development environment;
33+
34+
- Code standards, folder structure, and best practices adopted in the project;
35+
36+
- Detailed API documentation and usage examples;
37+
38+
Guidelines for contributing to the source code and submitting improvements.
39+
40+
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.
41+
42+
Blog
43+
----
44+
45+
Visit our `blog <https://libresign.coop/posts/>`__
46+
1747

1848
.. toctree::
1949
:maxdepth: 2
2050
:hidden:
2151

22-
introduction
2352
guide-api
2453
api
2554
code-of-conduct

developer_manual/introduction.rst

Lines changed: 0 additions & 31 deletions
This file was deleted.

user_manual/index.rst

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,44 @@
11
User Manual
22
=================
33

4-
Welcome to the user manual for the software. This documentation is designed to help you understand how to use the software effectively.
4+
Introduction
5+
============
6+
7+
What is Libresign?
8+
------------------
9+
10+
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.
11+
12+
About This Documentation
13+
------------------------
14+
15+
This section is intended for LibreSign users — individuals who need to sign, validate, or track digital documents in a simple and secure way.
16+
17+
Here you will find:
18+
19+
- Step-by-step guides on how to use the main features of the system;
20+
- Explanations of the user interface, including screens and menu options;
21+
- Instructions for performing digital signatures, viewing documents, and tracking process status;
22+
- Tips and answers to frequently asked questions (FAQ).
23+
24+
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.
25+
26+
Target audience
27+
---------------
28+
29+
- Public sector
30+
- Education
31+
- Private companies
32+
33+
Blog
34+
----
35+
36+
Visit our `blog <https://libresign.coop/posts/>`__
537

638
.. toctree::
739
:maxdepth: 2
840
:hidden:
941

10-
introduction
1142
start
1243
functionality
1344
faq

user_manual/introduction.rst

Lines changed: 0 additions & 33 deletions
This file was deleted.

0 commit comments

Comments
 (0)