Skip to content

Commit d7e8181

Browse files
mittalyashumittalyashu
committed
docs: update docs
1 parent d8f81b3 commit d7e8181

7 files changed

Lines changed: 132 additions & 24 deletions

File tree

‎content/docs/faq.md‎

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

‎content/docs/meta.json‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,16 @@
33
"pages": [
44
"---Introduction---",
55
"what-is-logchimp",
6-
"faq",
76
"---Getting Started---",
87
"install",
98
"environment-variables",
109
"---Architecture---",
1110
"architecture/index",
12-
"---Resources---",
13-
"support",
14-
"contributing"
11+
"---Miscellaneous---",
12+
"[HandHelping][Contributing](https://github.com/logchimp/logchimp/blob/master/CONTRIBUTING.md)",
13+
"miscellaneous/support",
14+
"miscellaneous/faq",
15+
"miscellaneous/security-policy"
1516
],
1617
"defaultOpen": true
1718
}

‎content/docs/miscellaneous/faq.mdx‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
---
2+
title: FAQs
3+
description: Comprehensive answers to common questions about LogChimp.
4+
icon: CircleQuestionMark
5+
---
6+
7+
import { Accordion, Accordions } from 'fumadocs-ui/components/accordion';
8+
import { InlineTOC } from 'fumadocs-ui/components/inline-toc';
9+
10+
<InlineTOC items={toc} />
11+
12+
## General
13+
14+
<Accordions type="multiple">
15+
<Accordion title="Who is LogChimp for?">
16+
LogChimp is ideal for Product managers, developers, and customer success teams who need a way to gather feedback
17+
without complex setups.
18+
</Accordion>
19+
20+
<Accordion title="What are key features of LogChimp?">
21+
LogChimp offers a set of features centered on feedback collection and management. Here's a breakdown:
22+
23+
| Feature | Description |
24+
| :--- | :--- |
25+
| Feedback collection | Create posts for feature requests, bugs, or ideas; users upvote/downvote to signal priority.
26+
|
27+
| Boards | Group posts into customizable boards (e.g., "Features," "Bugs") for better categorization. |
28+
| Roadmaps | Visualize planned work in a simple, public-facing view to keep customers informed. |
29+
| Comments | Reply to feedback in real-time (beta) |
30+
| Dashboard | Centralized admin panel to manage posts, users, roles, and analytics. |
31+
| Custom Branding | Add your logo, colors, and themes—reflects across the entire site. |
32+
| Role-Based Access Control (RBAC) | Granular permissions via REST APIs: Site Owner (full access), Admin (manage all), Manager (edit content), User (submit/vote), Viewer (read-only). Built-in for secure collaboration. |
33+
| Developer APIs | Self-consuming RESTful JSON APIs for integrations; easy tooling for custom workflows. |
34+
</Accordion>
35+
36+
<Accordion title="Does LogChimp support that feature?">
37+
No, currently it's not supported. But you're most welcome to [submit a feature
38+
request](https://github.com/logchimp/logchimp) anytime.
39+
</Accordion>
40+
</Accordions>
41+
42+
## Get Started
43+
44+
<Accordions>
45+
<Accordion title="How do I install and get started with LogChimp?">
46+
We've created detailed [deployment guides](/docs/install/getting-started) for various cloud providers, for you to get started with LogChimp in no time.
47+
</Accordion>
48+
</Accordions>
49+
50+
## Integrations
51+
52+
<Accordions>
53+
<Accordion title="Can I integrate LogChimp with other tools?">
54+
Yes, LogChimp's [**developer-friendly APIs**](/api-reference) make it easy to integrate with other tools.
55+
</Accordion>
56+
</Accordions>
57+
58+
## Licenses
59+
60+
<Accordions>
61+
<Accordion title="Is LogChimp open source, and what does the licensing look like?">
62+
Yes, LogChimp is fully open source under a dual licensing model, making it free for most uses while offering commercial options for enterprises.
63+
</Accordion>
64+
</Accordions>

‎content/docs/miscellaneous/security-policy.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
title: Security Reporting Policy
3+
description: Guidelines for responsible disclosure of security vulnerabilities at LogChimp.
4+
icon: Shield
5+
---
6+
7+
8+
## Introduction
9+
10+
At LogChimp, we take security very seriously and appreciate responsible disclosure of vulnerabilities that help us
11+
improve the software. We believe that security is a fundamental right of every human being. We want to make sure that
12+
our customers and their user's data are protected from any kind of security vulnerabilities.
13+
14+
## Reporting Security Vulnerabilities
15+
16+
Potential security vulnerabilities can be reported directly us at `logchimp@codecarrot.net`.
17+
18+
## How we handle Reports
19+
20+
LogChimp Core Team privately and works in a secured, isolated repository for tracking, testing, and resolving security-related issues.
21+
22+
## Responsible Disclosure
23+
24+
To ensure a responsible and ethical reporting process, please adhere to the following:
25+
26+
* **Do not publicly disclose** vulnerabilities until our team has had a reasonable time to address them.
27+
* **Do not exploit** the vulnerability beyond what is necessary to demonstrate the issue.
28+
* **Do not access, modify, or delete** data that does not belong to you.
29+
* **Do not perform** any activity that could disrupt the services of LogChimp, including but not limited to:
30+
* DDoS attacks
31+
* Brute force attacks
32+
* Spamming
33+
* Malware distribution
34+
* Virus distribution
35+
* Other malicious activity
36+
* **Do not** use any third-party tools to disclose the vulnerability.
37+
38+
Thanks for helping make LogChimp safe for everyone 🙏.

content/docs/support.md renamed to content/docs/miscellaneous/support.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: Support
33
description: How to get Support for LogChimp?
4+
icon: Headset
45
---
56

67
Please **do not** raise an issue on GitHub for help or support 😄. We use GitHub solely for bug-tracking and ongoing feature development.

‎content/docs/what-is-logchimp.mdx‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,18 @@ title: What is LogChimp?
33
icon: CircleQuestionMark
44
---
55

6-
import { Cards, Card, } from 'fumadocs-ui/components/card'
6+
import { Cards, Card } from 'fumadocs-ui/components/card'
77
import { RocketIcon, CableIcon, UsersIcon } from "lucide-react";
88

9-
LogChimp is an open-source software for startups and Enterprises to collect, prioritize, and act on customers' feedback.
9+
LogChimp is an open-source software for Startups, Businesses, Companies, and Enterprises to **collect, track, manage, engage with, and analyze** on customer's feedback.
1010

11-
By aggregating upvotes and downvotes on user-submitted posts, teams can visualize high-impact ideas and build multi-year product roadmaps.
11+
It helps prioritize product features based on upvotes and community input, enabling teams to build informed product roadmaps for years ahead.
12+
13+
It's built for **customer-driven teams** who want to stay aligned with user needs without guessing the feature big-feature.
14+
15+
### Key Benefits
16+
17+
Full data control (100% data ownership with self-hosting), whitelabel branding, and seamless integration into your product development workflow.
1218

1319
LogChimp is designed to fit and scale with your existing system by providing a unified API, feedback widget _(coming soon)_ component that can be integrated with a few lines of code.
1420

‎content/guide/dashboard/role-permission.md‎

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,18 @@ title: Roles & Permissions
33
icon: IdCardLanyard
44
---
55

6-
LogChimp uses Role-Based Access Control (RBAC) for secure access.
6+
LogChimp uses Role-Based Access Control (RBAC) to secure its RESTful JSON APIs, ensuring only authorized users can
7+
access the data. It's built-in and configurable via the dashboard.
8+
9+
### Roles overview
10+
11+
| Role | Description |
12+
|------------------|---------------------------------------------------------------------|
13+
| Site Owner | Immutable super-admin; full access including billing. |
14+
| Admin | Manage all data, users, and settings. |
15+
| Manager | Edit posts, invite users, assign boards/roadmaps, moderate content. |
16+
| Editor/Moderator | Edit posts, moderate content. |
17+
| User | Submit post, up/down vote. |
18+
| Viewer | Read-only access. |
19+
20+
The roles in the above table are just for an example, you can create your own roles and assign permissions to them.

0 commit comments

Comments
 (0)