Skip to content

Commit b310edf

Browse files
DeekshithSHDeekshithSH
committed
Add About Us page
1 parent c669002 commit b310edf

4 files changed

Lines changed: 174 additions & 3 deletions

File tree

‎docs/about/contact.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Contact
2+
3+
If you have questions, suggestions, or issues related to **TG-FileStream**, you can reach out using the information below.
4+
5+
---
6+
7+
## Project Author
8+
9+
**Name:** Deekshith SH
10+
**Email:** mail@spri.in
11+
12+
---
13+
14+
## Reporting Issues
15+
16+
For bugs, feature requests, or improvements, please use the official GitHub repository:
17+
18+
https://github.com/SpringsFern/TG-FileStream
19+
20+
When reporting an issue, please include:
21+
22+
- Steps to reproduce
23+
- Expected vs actual behavior
24+
- Relevant logs (if applicable)
25+
- Environment details (OS, Python version, etc.)
26+
27+
---
28+
29+
## Contributions
30+
31+
Contributions are welcome.
32+
33+
You may:
34+
35+
- Open pull requests
36+
- Submit translations
37+
- Create patches
38+
- Suggest improvements to documentation
39+
40+
Thank you for supporting the project.

‎docs/about/index.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# About
2+
3+
Welcome to the official documentation site for **TG-FileStream**.
4+
5+
TG-FileStream is an open-source project that acts as a lightweight Telegram client and HTTP proxy, allowing Telegram media files to be streamed and downloaded via direct HTTP links.
6+
7+
This documentation site is built to help users:
8+
9+
- Deploy TG-FileStream on a VPS
10+
- Configure environment variables properly
11+
- Set up production-ready infrastructure
12+
- Customize the bot using patches
13+
- Extend functionality through plugins and translations
14+
15+
---
16+
17+
## About the Project
18+
19+
TG-FileStream is developed and maintained by **Deekshith SH**.
20+
21+
The project is released under the **GNU AGPL v3 license**, which means:
22+
23+
- You are free to use, modify, and distribute it
24+
- Any modifications must also be shared under the same license
25+
26+
The goal of this project is to provide a reliable, configurable, and extensible Telegram file streaming solution.
27+
28+
---
29+
30+
## About This Documentation Site
31+
32+
This documentation site is powered by **Zensical**.
33+
34+
It is designed to provide structured and easy-to-follow guides for deployment and customization.
35+
36+
We continuously improve both the project and the documentation.
37+
38+
If you find something unclear or incorrect, contributions and feedback are always welcome.
39+
40+
---
41+
42+
Thank you for using TG-FileStream.

‎docs/about/privacy.md‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# Privacy Policy
2+
3+
Last updated: 01-03-2026
4+
5+
This Privacy Policy explains how information is handled when you visit this website.
6+
7+
---
8+
9+
## 1. Information We Collect
10+
11+
This documentation website does **not** directly collect personal information such as:
12+
13+
- Names
14+
- Email addresses
15+
- Passwords
16+
- Telegram account data
17+
18+
We do not provide user accounts or store user-submitted data.
19+
20+
However, basic technical information may be collected automatically by your browser or hosting provider, such as:
21+
22+
- IP address
23+
- Browser type
24+
- Device type
25+
- Pages visited
26+
27+
This is standard for most websites.
28+
29+
---
30+
31+
## 2. Google AdSense
32+
33+
This website uses **Google AdSense** to display advertisements.
34+
35+
Google may use cookies and similar technologies to:
36+
37+
- Serve personalized ads
38+
- Measure ad performance
39+
- Improve advertising services
40+
41+
Information that may be collected by Google includes:
42+
43+
- IP address
44+
- Browser and device information
45+
- Pages visited
46+
47+
You can learn more about how Google uses data here:
48+
49+
https://policies.google.com/technologies/ads
50+
51+
You can control ad personalization here:
52+
53+
https://adssettings.google.com
54+
55+
---
56+
57+
## 3. Cookies
58+
59+
Cookies may be used by Google AdSense to display and personalize ads.
60+
61+
You can disable cookies through your browser settings.
62+
Please note that disabling cookies may affect how ads are displayed.
63+
64+
---
65+
66+
## 4. Third-Party Services
67+
68+
Apart from Google AdSense and standard hosting infrastructure, we do not use additional tracking or analytics services.
69+
70+
---
71+
72+
## 5. Changes to This Policy
73+
74+
This Privacy Policy may be updated occasionally.
75+
Any updates will be posted on this page.
76+
77+
---
78+
79+
## 6. Contact
80+
81+
If you have any questions regarding this Privacy Policy, please contact:
82+
83+
mail@spri.in

‎zensical.toml‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ site_url = "https://docs.tgfs.spri.in/"
3535
# Read more: https://zensical.org/docs/setup/basics/#copyright
3636
copyright = """
3737
Copyright © 2026 Deekshith SH
38+
<br><a href="/about/privacy">Privacy Policy</a>
3839
"""
3940

4041
# Zensical supports both implicit navigation and explicitly defined navigation.
@@ -73,6 +74,11 @@ nav = [
7374
{"Environment Variables" = [
7475
"environment-variables/description.md",
7576
"environment-variables/env-builder.md"
77+
]},
78+
{"About Us" = [
79+
"about/index.md",
80+
"about/contact.md",
81+
"about/privacy.md"
7682
]}
7783
]
7884

@@ -328,8 +334,8 @@ toggle.name = "Switch to light mode"
328334
# ----------------------------------------------------------------------------
329335
# The "extra" section contains miscellaneous settings.
330336
# ----------------------------------------------------------------------------
331-
#[[project.extra.social]]
332-
#icon = "fontawesome/brands/github"
333-
#link = "https://github.com/user/repo"
337+
[[project.extra.social]]
338+
icon = "fontawesome/brands/github"
339+
link = "https://github.com/SpringsFern/docs"
334340

335341

0 commit comments

Comments
 (0)