Skip to content

Commit 672989f

Browse files
mani-d1mani-d1
committed
Merge branch 'Common' of github.com:virtualansoftware/doculan-tutorials
test
2 parents eff08d9 + 9731efa commit 672989f

File tree

124 files changed

+2517
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

124 files changed

+2517
-0
lines changed

‎Readme.md‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
# Install Git:
2+
3+
Goto https://git-scm.com/download/ and download Git for windows or Mac or Linux/Unix.
4+
5+
Install Git with the recommended settings.
6+
7+
# Install Visual studio Code:
8+
9+
Goto https://code.visualstudio.com/download and download Git for windows or Mac or Linux/Unix.
10+
11+
Install VS code with the recommended settings.
12+
13+
# Install Node JS:
14+
15+
Goto https://nodejs.org/en/download/ for the respective OS.
16+
17+
Install Node JS with the default settings.
18+
19+
# GITHUB setup:
20+
21+
1. Goto https://github.com/ and create a new account using sign-up.
22+
23+
## Setup SSH key:
24+
25+
1. Open Git Bash window.
26+
2. Enter ssh-keygen -t ed25519 -C your_email@example.com
27+
3. Enter file in which to save the key -> prefer to the default location as it does not give access error in further steps.
28+
4. Enter passphrase and the ssh public and private keys are generated on the specified location.
29+
5. Next add the SSH key to Git Hub.
30+
Reference: https://docs.github.com/en/enterprise-server@3.0/github/authenticating-to-github/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account
31+
32+
- Login to https://github.com/ with your credentials.
33+
- Copy the SSH public key to your clipboard.
34+
- In the upper-right corner of any page, click your profile photo, then click Settings.
35+
- In the user settings sidebar, click SSH and GPG keys.
36+
- Click New SSH key or Add SSH key.
37+
- In the "Title" field, add a descriptive label for the new key.
38+
- Paste your key into the "Key" field.
39+
- Click Add SSH key.
40+
- If prompted, confirm your GitHub Enterprise Server password.
41+
42+
## Get the clone URL:
43+
44+
1. Then goto https://github.com/virtualansoftware on a new browser tab.
45+
3. GO down the page and click on the project 'tutorials'.
46+
4. If you have logged in Github you will see a button 'Fork' in the top right corner of the page.
47+
5. Then click on the green button 'Code' and copy the ssh Url.
48+
git@github.com:<GitHub username>/tutorials.git
49+
50+
# Install docsify:
51+
52+
1. Create a folder on any location you prefer. This will be used to edit the tutorials page.
53+
2. Right click and select 'Git Bash Here'.
54+
3. Git bash window will open.
55+
4. Run the below commands one after another.
56+
- git clone git@github.com:<username>/tutorials.git
57+
- npm i docsify-cli -g
58+
- cd tutorials/
59+
- docsify serve docs
60+
5. Open a browser and goto http://localhost:3000/#/ and you can open Virtualan page.
61+
62+
# To Edit tutorials page:
63+
64+
1. Open Visual studio code window.
65+
2. click File menu -> Open Folder
66+
3. Goto Folder you created to install docsify\Git\tutorials and click Select Folder.
67+
4. Once you slelect the Tutorials folder, all the paged will be displayed on the Explorer window.
68+
69+
As you start to EDIT on the Visual studio code window refresh the browser to see the changes (http://localhost:3000/#/).
70+
71+
# How to COMMIT the changes:
72+
1. Exit out of the Git Bash running command Listening at http://localhost:3000
73+
2. Run the below commands for the first time when you commit the changes.
74+
git config --global user.email "you@example.com"
75+
git config --global user.name "Your Name"
76+
3. Run
77+
git commit -am "updated"
78+
Add appropriate comments inside the "".
79+
4. Then Run
80+
git push
81+
82+
# Create PULL request:
83+
1. Go to "https://github.com/<username>/tutorials/pulls" to create a New Pull request.
84+
2. Click on the Green "New Pull Request" button to create a new request between your master branch to Virtualan Master branch.

‎docs/.nojekyll‎

Whitespace-only changes.

‎docs/Contacts/Contact-Delete.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# ✅ Steps to Delete Contact
2+
3+
1. Open the **Contacts** page to view all contacts.
4+
2. Click the **Delete (trash icon)** next to the contact you want to remove.
5+
3. Confirm by clicking **Delete**.
6+
4. The contact will be deleted successfully.
7+
8+
**Screenshot1:**
9+
10+
<img src="screenshots\Contacts\Contact-Delete1.png" alt="Step 1 — Delete Contact" style="border:2px solid black; border-radius:4px; width:100%; max-width:800px;">
11+
12+
**Screenshot2:**
13+
14+
<img src="screenshots\Contacts\Contact-Delete2.png" alt="Step 2 — Delete Contact" style="border:2px solid black; border-radius:4px; width:100%; max-width:800px;">
15+
16+
---> The above **Screenshots** represent that how to **Delete Contact.**
17+
18+
**Demo Video:**
19+
<!-- Inline HTML in Markdown file -->
20+
<style>
21+
.video-wrap {
22+
border: 2px solid black;
23+
border-radius: 4px;
24+
width: 100%;
25+
max-width: 800px;
26+
overflow: hidden;
27+
margin-bottom: 1rem;
28+
}
29+
.video-wrap video {
30+
display: block;
31+
width: 100%;
32+
height: auto;
33+
}
34+
</style>
35+
36+
<div class="video-wrap" role="region" aria-label="Demo: Creating a form">
37+
<!-- Use a relative path like ./videos/demo.mp4 or an absolute URL -->
38+
<video controls poster="screenshots\Thumbnail\DemoPics.png">
39+
<source src="https://doculan-storage-public.s3.us-east-1.amazonaws.com/tutorials/Contact-Delete.mp4" type="video/mp4">
40+
<source src="https://doculan-storage-public.s3.us-east-1.amazonaws.com/tutorials/Contact-Delete.webm" type="video/webm">
41+
<!-- Fallback link if browser can't play video -->
42+
Your browser does not support the video tag.
43+
<a href="https://doculan-storage-public.s3.us-east-1.amazonaws.com/tutorials/Contact-Delete.mp4" target="_blank" rel="noopener">Download / Open video</a>
44+
</video>
45+
</div>
46+
47+
---> The above **Video** represent that how to **Delete Contact.**

‎docs/Contacts/Contact-Update.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# ✅ Steps to Update Contact
2+
3+
1. Go to the **Contacts** page to view existing contacts.
4+
2. Click the **Edit (pen icon)** next to the contact you want to modify.
5+
3. Update the contact details (Name, Email, Phone Number, etc.).
6+
4. Click **Save Changes**.
7+
5. The contact information will be updated successfully.
8+
9+
**Screenshot1:**
10+
11+
<img src="screenshots\Contacts\Contact-Update1.png" alt="Step 1 — Update Contact" style="border:2px solid black; border-radius:4px; width:100%; max-width:800px;">
12+
13+
**Screenshot2:**
14+
15+
<img src="screenshots\Contacts\Contact-Update2.png" alt="Step 2 — Update Contact" style="border:2px solid black; border-radius:4px; width:100%; max-width:800px;">
16+
17+
---> The above **Screenshots** represent that how to **Update Contact.**
18+
19+
**Demo Video:**
20+
<!-- Inline HTML in Markdown file -->
21+
<style>
22+
.video-wrap {
23+
border: 2px solid black;
24+
border-radius: 4px;
25+
width: 100%;
26+
max-width: 800px;
27+
overflow: hidden;
28+
margin-bottom: 1rem;
29+
}
30+
.video-wrap video {
31+
display: block;
32+
width: 100%;
33+
height: auto;
34+
}
35+
</style>
36+
37+
<div class="video-wrap" role="region" aria-label="Demo: Creating a form">
38+
<!-- Use a relative path like ./videos/demo.mp4 or an absolute URL -->
39+
<video controls poster="screenshots\Thumbnail\DemoPics.png">
40+
<source src="https://doculan-storage-public.s3.us-east-1.amazonaws.com/tutorials/Contact-Update.mp4" type="video/mp4">
41+
<source src="https://doculan-storage-public.s3.us-east-1.amazonaws.com/tutorials/Contact-Update.webm" type="video/webm">
42+
<!-- Fallback link if browser can't play video -->
43+
Your browser does not support the video tag.
44+
<a href="https://doculan-storage-public.s3.us-east-1.amazonaws.com/tutorials/Contact-Update.mp4" target="_blank" rel="noopener">Download / Open video</a>
45+
</video>
46+
</div>
47+
48+
---> The above **Video** represent that how to **Update Contact.**

‎docs/Contacts/Contact_Create.md‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# ✅ Steps to Create Contact
2+
3+
1. Open the **Doculan Dashboard** and go to the **Contacts** section.
4+
2. Click on **Add Contact**.
5+
3. Fill in all required details such as:
6+
- Full Name
7+
- Email Address
8+
- Mobile Number
9+
- Other optional fields
10+
4. Click **Add Contact** to save.
11+
5. The contact will be successfully created and stored in the system.
12+
13+
**Screenshot1:**
14+
15+
<img src="screenshots\Contacts\Contact-Create1.png" alt="Step 1 — Create Contact" style="border:2px solid black; border-radius:4px; width:100%; max-width:800px;">
16+
17+
---> The above **Screenshot** represent that how to **Create Contact.**
18+
19+
**Demo Video:**
20+
<!-- Inline HTML in Markdown file -->
21+
<style>
22+
.video-wrap {
23+
border: 2px solid black;
24+
border-radius: 4px;
25+
width: 100%;
26+
max-width: 800px;
27+
overflow: hidden;
28+
margin-bottom: 1rem;
29+
}
30+
.video-wrap video {
31+
display: block;
32+
width: 100%;
33+
height: auto;
34+
}
35+
</style>
36+
37+
38+
39+
40+
41+
<div class="video-wrap" role="region" aria-label="Demo: Creating a form">
42+
<!-- Use a relative path like ./videos/demo.mp4 or an absolute URL -->
43+
<video controls poster="screenshots\Thumbnail\DemoPics.png">
44+
<source src="https://doculan-storage-public.s3.us-east-1.amazonaws.com/tutorials/Contact-Create.mp4" type="video/mp4">
45+
<source src="https://doculan-storage-public.s3.us-east-1.amazonaws.com/tutorials/Contact-Create.webm" type="video/webm">
46+
<!-- Fallback link if browser can't play video -->
47+
Your browser does not support the video tag.
48+
<a href="https://doculan-storage-public.s3.us-east-1.amazonaws.com/tutorials/Contact-Create.mp4" target="_blank" rel="noopener">Download / Open video</a>
49+
</video>
50+
</div>
51+
52+
---> The above **Video** represent that how to **Create Contact.**

‎docs/Document/Documents_Create.md‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# ✅ Steps to Create a New Document
2+
3+
1. Go to **Doculan Dashboard → Documents → Create**
4+
2. Choose your preferred method:
5+
- ✍️ **Create manually**, or
6+
- 🤖 **Use AI to generate the document**
7+
3. Start writing or editing your text
8+
4. Format the document as needed:
9+
- Change **font styles & colors**
10+
- **Increase / Decrease** font size
11+
- Insert **images**, **logos**, or **pages**
12+
5. Doculan provides **spell check** to ensure accuracy
13+
6. Save the document (**PDF format only**)
14+
15+
**Screenshot1:**
16+
17+
<img src="screenshots\Document\Document-Create.png" alt="Step 1 — Create a New Document" style="border:2px solid black; border-radius:4px; width:100%; max-width:800px;">
18+
19+
**Screenshot2:**
20+
21+
<img src="screenshots\Document\Document-Create2.png" alt="Step 2 — Create a New Document" style="border:2px solid black; border-radius:4px; width:100%; max-width:800px;">
22+
23+
---> The above **Screenshots** represent that how to **Create a new Document.**
24+
25+
**Demo Video:**
26+
<!-- Inline HTML in Markdown file -->
27+
<style>
28+
.video-wrap {
29+
border: 2px solid black;
30+
border-radius: 4px;
31+
width: 100%;
32+
max-width: 800px;
33+
overflow: hidden;
34+
margin-bottom: 1rem;
35+
}
36+
.video-wrap video {
37+
display: block;
38+
width: 100%;
39+
height: auto;
40+
}
41+
</style>
42+
43+
<div class="video-wrap" role="region" aria-label="Demo: Creating a form">
44+
<!-- Use a relative path like ./videos/demo.mp4 or an absolute URL -->
45+
<video controls poster="screenshots\Thumbnail\DemoPics.png">
46+
<source src="https://doculan-storage-public.s3.us-east-1.amazonaws.com/tutorials/Document-Create.mp4" type="video/mp4">
47+
<source src="https://doculan-storage-public.s3.us-east-1.amazonaws.com/tutorials/Document-Create.webm" type="video/webm">
48+
<!-- Fallback link if browser can't play video -->
49+
Your browser does not support the video tag.
50+
<a href="./video/https://doculan-storage-public.s3.us-east-1.amazonaws.com/tutorials/Document-Create.mp4" target="_blank" rel="noopener">Download / Open video</a>
51+
</video>
52+
</div>
53+
54+
---> The above **Video** represent that how to **Create Document.**
55+

‎docs/Document/Documents_Upload.md‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# ✅ Steps to Upload to Doculan Storage
2+
3+
- Documents can be saved **locally** or in **Doculan Storage**
4+
- If saving to Doculan storage:
5+
- Select the correct **folder path / storage path**
6+
- Upload the **PDF file**
7+
8+
**Screenshot1:**
9+
10+
<img src="screenshots\Document\Document-Upload1.png" alt="Step 1 — Upload to Doculan Storage
11+
" style="border:2px solid black; border-radius:4px; width:100%; max-width:800px;">
12+
13+
**Screenshot2:**
14+
15+
<img src="screenshots\Document\Document-Upload2.png" alt="Step 2 — Upload to Doculan Storage
16+
" style="border:2px solid black; border-radius:4px; width:100%; max-width:800px;">
17+
18+
---> The above **Screenshots** represent that how to **Upload Document.**
19+
20+
**Demo Video:**
21+
<!-- Inline HTML in Markdown file -->
22+
<style>
23+
.video-wrap {
24+
border: 2px solid black;
25+
border-radius: 4px;
26+
width: 100%;
27+
max-width: 800px;
28+
overflow: hidden;
29+
margin-bottom: 1rem;
30+
}
31+
.video-wrap video {
32+
display: block;
33+
width: 100%;
34+
height: auto;
35+
}
36+
</style>
37+
38+
<div class="video-wrap" role="region" aria-label="Demo: Creating a form">
39+
<!-- Use a relative path like ./videos/demo.mp4 or an absolute URL -->
40+
<video controls poster="screenshots\Thumbnail\DemoPics.png">
41+
<source src="https://doculan-storage-public.s3.us-east-1.amazonaws.com/tutorials/Document-Upload.mp4" type="video/mp4">
42+
<source src="https://doculan-storage-public.s3.us-east-1.amazonaws.com/tutorials/Document-Upload.webm" type="video/webm">
43+
<!-- Fallback link if browser can't play video -->
44+
Your browser does not support the video tag.
45+
<a href="https://doculan-storage-public.s3.us-east-1.amazonaws.com/tutorials/Document-Upload.mp4" target="_blank" rel="noopener">Download / Open video</a>
46+
</video>
47+
</div>
48+
49+
---> The above **Video** represent that how to **Upload Document.**

0 commit comments

Comments
 (0)