Skip to content

added faq page #90

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Dhairya211206 wants to merge 1 commit into from
Closed

added faq page #90

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 56 additions & 0 deletions opsimate-docs/docs/FAQ.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
id: FAQ
title: Frequently Asked Questions

---
# Frequently Asked Questions (FAQ)

Welcome to the OpsiMate FAQ!
This page provides quick answers to common questions about installation, configuration, and contributing to OpsiMate.



## 🔍 General

**What is OpsiMate?**
OpsiMate is an open-source tool designed to simplify managing Opsi environments, automate configuration, and help both new and experienced users streamline their workflows.

**Who maintains OpsiMate?**
OpsiMate is maintained by the community, with contributors focused on improving installation, performance, and usability.

**Is OpsiMate free to use?**
Yes! OpsiMate is open source and completely free under its license.


## ⚙️ Installation & Configuration

**How do I install OpsiMate?**
Check the [Introduction](intro.md) for setup instructions.

**Can I integrate OpsiMate with other tools?**
Yes — OpsiMate supports integrations. See [Core Features](core-features.md) for details.

**Where is the configuration file located?**
Configuration details are explained in the installation section.



## 🧑‍💻 Contributing & Community

**How can I contribute?**
Read our [Development Guide](development.md) to learn how to contribute, submit PRs, or suggest new features.

**Where can I ask questions or report issues?**
Open a discussion or issue on our [GitHub repository](https://github.com/OpsiMate/documentation).

**Do I need approval before contributing?**
Not for small changes! For major updates, please open an issue to discuss the approach first.



## 🔗 Useful Links

- [Introduction](intro.md)
- [Core Features](core-features.md)
- [Development Guide](development.md)
- [GitHub Repository](https://github.com/OpsiMate/documentation)
8 changes: 7 additions & 1 deletion opsimate-docs/sidebars.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
*/

// @ts-check
// @ts-nocheck
Comment on lines 12 to +13
Copy link

@coderabbitai coderabbitai bot Oct 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Remove contradictory type-checking directives.

Having both @ts-check (Line 12) and @ts-nocheck (Line 13) in the same file is contradictory. The @ts-nocheck directive effectively cancels out @ts-check, disabling type checking entirely.

Either remove @ts-nocheck if you want type checking enabled, or remove both directives if type checking is not needed:

 // @ts-check
-// @ts-nocheck
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
// @ts-check
// @ts-nocheck
// @ts-check
🤖 Prompt for AI Agents 
In opsimate-docs/sidebars.js around lines 12 to 13, the file contains both "//
@ts-check" and "// @ts-nocheck" which are contradictory; remove the "//
@ts-nocheck" line if you want TypeScript checking enabled, or remove both
directives (or keep only "// @ts-nocheck") if you want to disable type
checking—update the file to contain a single consistent directive reflecting the
desired type-checking behavior.


/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebars = {
Expand Down Expand Up @@ -86,9 +87,14 @@ const sidebars = {
type: 'category',
label: 'User Management & Security',
collapsed: true,
items: ['user-management/register-login', 'user-management/admin-panel', 'user-management/audit-logs'],
items: [
'user-management/register-login',
'user-management/admin-panel',
'user-management/audit-logs',
],
},
'development',
'FAQ',
],
};

Expand Down
2 changes: 2 additions & 0 deletions opsimate-docs/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
{
// @ts-nocheck

// This file is not used in compilation. It is here just for a nice editor experience.
"extends": "@docusaurus/tsconfig",
"compilerOptions": {
Expand Down
Loading