Skip to content

Commit c800597

Browse files
authored
Updated docs (#17)
* Add about section * Add all introduction section * Add component overviews
1 parent 3b42999 commit c800597

25 files changed

+166
-27
lines changed

docs/.vitepress/config.js

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,11 @@ export default {
3939
collapsed: false,
4040
items: [
4141
{ text: 'About PERSCOM', link: '/about' },
42+
{ text: 'Find My Organization', link: '/find-my-organization' },
4243
{ text: 'Getting Started', link: '/getting-started' },
4344
{ text: 'Pricing', link: '/pricing' },
4445
{ text: 'Registration', link: '/registration' },
45-
{ text: 'Find My Organization', link: '/find-my-organization' }
46+
{ text: 'Support', link: '/support' }
4647
]
4748
},
4849
{
@@ -59,7 +60,7 @@ export default {
5960
{ text: 'Statuses', link: '/components/statuses' },
6061
{ text: 'Tasks', link: '/components/tasks' },
6162
{ text: 'Units', link: '/components/units' },
62-
{ text: 'Users', link: '/components/users' },
63+
{ text: 'Users', link: '/components/users' }
6364
]
6465
},
6566
{

docs/about.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
11
# About
22

3-
Still working on it...
3+
PERSCOM.io is the ultimate solution for para-military organizations looking to manage their personnel. Our platform offers a comprehensive
4+
suite of tools to help you keep track of all aspects of personnel management, from records and qualification tracking to personnel
5+
organization and custom data management.
6+
7+
With PERSCOM.io, you can easily manage personnel information, track their qualifications, and monitor their performance. Our software also
8+
allows you to create custom positions and specialties, as well as define your organization structure with units.
9+
10+
We understand the importance of integrating your data with other systems, which is why we offer the ability to integrate with any
11+
third-party service through our API or OAuth 2.0. Additionally, our platform offers the ability to create custom forms and track
12+
submissions, making it easy for you to collect data and manage your personnel information.
13+
14+
PERSCOM.io is designed to be user-friendly and accessible from anywhere, so you can manage your personnel from the office, the field, or
15+
on-the-go. With our comprehensive platform, you can simplify your personnel management processes and focus on what's truly important - your
16+
mission.
17+
18+
Join the revolution in para-military personnel management and see the difference PERSCOM.io can make for your organization. Sign up for a
19+
[demo](https://perscom.io/register) today and take the first step towards a more efficient and effective way of managing your personnel.

docs/components/announcements.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
11
# Announcements
22

3+
You can use the announcements feature in PERSCOM.io to communicate with your personnel in real-time. This feature allows you to post global
4+
messages directly to your dashboard, ensuring that all of your personnel have access to the most up-to-date information. This feature is
5+
especially useful for para-military organizations that need to communicate with personnel across multiple locations, as it provides a quick
6+
and efficient way to share information with all of your personnel, no matter where they are.
7+
38
## Permissions
49

510
The following permissions are related to managing announcements.
611

712
- `view:announcement` Can view an announcement.
813
- `create:announcement` Can create a new announcement.
914
- `update:announcement` Can update an existing announcement.
10-
- `delete:announcement` Can delete an existing announcement.
15+
- `delete:announcement` Can delete an existing announcement.

docs/components/awards.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,16 @@
11
# Awards
22

3+
The Awards feature in our service allows organizations to establish and manage their own recognition system. With this feature,
4+
organizations can create custom awards, set criteria for earning these awards, and track the awards earned by their personnel. This flexible
5+
system provides a way for organizations to acknowledge the achievements and contributions of their personnel, and align with established
6+
policies and procedures. Whether you want to recognize top performers, milestones, or simply show appreciation, our Awards feature gives you
7+
the tools you need to create a meaningful recognition program.
8+
39
## Permissions
410

511
The following permissions are related to managing awards.
612

713
- `view:award` Can view an award.
814
- `create:award` Can create a new award.
915
- `update:award` Can update an existing award.
10-
- `delete:award` Can delete an existing award.
16+
- `delete:award` Can delete an existing award.

docs/components/documents.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,19 @@
11
# Documents
22

3+
The Documents feature in our service provides organizations with a centralized document library to store and manage important files. With
4+
this feature, organizations can upload and store documents, such as manuals, policies, procedures, and forms, in a secure and easily
5+
accessible location. The Documents feature also enables organizations to assign documents to other components of the service, such as
6+
personnel, tasks, and and service records. This makes it easy to ensure that personnel have access to the most up-to-date versions of
7+
important files and that records are properly documented. The Documents feature provides organizations with a convenient and organized way
8+
to store and manage their most critical information, making it easy to find the information you need, when you need it. Whether you need to
9+
store and organize internal documents or share information with your personnel, our Documents feature gives you the tools you need to stay
10+
organized and efficient.
11+
312
## Permissions
413

514
The following permissions are related to managing documents.
615

716
- `view:document` Can view a document.
817
- `create:document` Can create a new document.
918
- `update:document` Can update an existing document.
10-
- `delete:document` Can delete an existing document.
19+
- `delete:document` Can delete an existing document.

docs/components/positions.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,17 @@
11
# Positions
22

3+
The Positions feature in our service allows organizations to define and manage the different positions within their organizational
4+
structure. With this feature, organizations can create custom positions and specify the roles and responsibilities associated with each one.
5+
This makes it easy to track who is responsible for what within the organization and ensures that everyone is aware of their specific
6+
responsibilities. The Positions feature provides organizations with greater visibility into their personnel structure, making it easier to
7+
manage and allocate resources as needed. Whether you are tracking upper management positions or defining specific roles within your
8+
organization, the Positions feature gives you the tools you need to define and manage your personnel structure with ease.
9+
310
## Permissions
411

512
The following permissions are related to managing positions.
613

714
- `view:position` Can view a position.
815
- `create:position` Can create a new position.
916
- `update:position` Can update an existing position.
10-
- `delete:position` Can delete an existing position.
17+
- `delete:position` Can delete an existing position.

docs/components/qualifications.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
1-
# Awards
1+
# Qualifications
2+
3+
The Qualifications feature in our service enables organizations to establish and manage their own training and certification programs. This
4+
feature allows organizations to create custom qualifications, define requirements for earning these qualifications, and track the progress
5+
of their personnel. With this feature, organizations can ensure their personnel meet established policies and procedures and are equipped
6+
with the necessary skills and knowledge to perform their duties effectively. Whether you need to track certifications, licenses, or in-house
7+
training, our Qualifications feature provides a flexible and comprehensive solution to manage your organization's training and development
8+
programs.
29

310
## Permissions
411

@@ -7,4 +14,4 @@ The following permissions are related to managing qualifications.
714
- `view:qualification` Can view a qualification.
815
- `create:qualification` Can create a new qualification.
916
- `update:qualification` Can update an existing qualification.
10-
- `delete:qualification` Can delete an existing qualification.
17+
- `delete:qualification` Can delete an existing qualification.

docs/components/ranks.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,16 @@
11
# Ranks
22

3+
The Ranks feature in our service provides organizations with the ability to manage their chain of command structure. This feature allows
4+
organizations to create custom ranks, define the criteria for promotions and demotions, and assign ranks to personnel based on their
5+
performance and achievements. With this feature, organizations can clearly define the hierarchy of their personnel, maintain accountability,
6+
and promote a sense of structure and organization. Whether you are managing a small unit or a large organization, our Ranks feature gives
7+
you the tools you need to establish and maintain your chain of command.
8+
39
## Permissions
410

511
The following permissions are related to managing ranks.
612

713
- `view:rank` Can view a rank.
814
- `create:rank` Can create a new rank.
915
- `update:rank` Can update an existing rank.
10-
- `delete:rank` Can delete an existing rank.
16+
- `delete:rank` Can delete an existing rank.

docs/components/specialties.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
1-
# Specialtys
1+
# Specialities
2+
3+
The Specialities feature in our service allows organizations to track and manage the specific jobs and responsibilities of their personnel.
4+
This feature enables organizations to create custom specialties, assign personnel to these specialties, and track the performance and
5+
progress of their personnel in these roles. With this feature, organizations can ensure that their personnel are equipped with the right
6+
skills and knowledge to perform their job duties effectively and efficiently. Whether you need to track medical specialties, technical
7+
specialties, or any other job function, our Specialties feature provides a comprehensive solution to manage and track the roles and
8+
responsibilities of your personnel.
29

310
## Permissions
411

@@ -7,4 +14,4 @@ The following permissions are related to managing specialtys.
714
- `view:specialty` Can view a specialty.
815
- `create:specialty` Can create a new specialty.
916
- `update:specialty` Can update an existing specialty.
10-
- `delete:specialty` Can delete an existing specialty.
17+
- `delete:specialty` Can delete an existing specialty.

docs/components/statuses.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ The following permissions are related to managing statuses.
77
- `view:status` Can view a status.
88
- `create:status` Can create a new status.
99
- `update:status` Can update an existing status.
10-
- `delete:status` Can delete an existing status.
10+
- `delete:status` Can delete an existing status.

0 commit comments

Comments
 (0)