Skip to content

Commit 55caa8d

Browse files
Add docs as part of release
1 parent 0174c06 commit 55caa8d

File tree

11 files changed

+118
-0
lines changed

11 files changed

+118
-0
lines changed

docs/api/README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
icon: hand-wave
3+
---
4+
5+
# Welcome
6+
7+
Welcome to the LightSwitch API documentation. This API allows you to seamlessly integrate with the LightSwitch platform, enabling efficient management of users, projects, and tasks.
8+
9+
### Key Features
10+
11+
* **User Management:** Create, update, and manage user profiles within your application.
12+
* **Project Handling:** Efficiently manage projects, track progress, and collaborate with team members.
13+
* **Task Management:** Organize tasks, set priorities, and ensure timely completion.
14+
15+
### Getting Started
16+
17+
To begin using the LightSwitch API, you will need to:
18+
19+
1. **Register for an API Key:** Sign up on the LightSwitch platform to receive your unique API key.
20+
2. **Review the API Documentation:** Familiarize yourself with the API endpoints and request formats.
21+
3. **Implement API Calls:** Integrate API calls into your application to perform various actions.
22+
23+
### Support
24+
25+
For assistance, visit our support page or contact our tech team for help.
26+
27+
Explore the LightSwitch API to enhance your productivity and streamline project management processes!

docs/api/SUMMARY.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Table of contents
2+
3+
## Getting started
4+
5+
* [Welcome](README.md)
6+
7+
## Users
8+
9+
* [GET /users](users/users.get.md)
10+
* [POST /users](users/users.post.md)
11+
12+
## Projects
13+
14+
* [GET /projects](projects/projects.get.md)
15+
* [POST /projects](projects/projects.post.md)
16+
17+
## Tasks
18+
19+
* [GET /tasks](tasks/tasks.get.md)
20+
* [PUT /tasks](tasks/tasks.put.md)
21+
* [POST /tasks](tasks/tasks.post.md)

docs/api/projects/projects.get.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# GET /projects
2+
3+
{% swagger src="https://lightswitch.gitbook.dev/openapi.json" path="/projects" method="get" %}
4+
[https://lightswitch.gitbook.dev/openapi.json](https://lightswitch.gitbook.dev/openapi.json)
5+
{% endswagger %}
6+

docs/api/projects/projects.post.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# POST /projects
2+
3+
{% swagger src="https://lightswitch.gitbook.dev/openapi.json" path="/projects" method="post" %}
4+
[https://lightswitch.gitbook.dev/openapi.json](https://lightswitch.gitbook.dev/openapi.json)
5+
{% endswagger %}
6+

docs/api/tasks/tasks.get.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# GET /tasks
2+
3+
{% swagger src="https://lightswitch.gitbook.dev/openapi.json" path="/tasks" method="get" %}
4+
[https://lightswitch.gitbook.dev/openapi.json](https://lightswitch.gitbook.dev/openapi.json)
5+
{% endswagger %}
6+

docs/api/tasks/tasks.post.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# POST /tasks
2+
3+
{% swagger src="https://lightswitch.gitbook.dev/openapi.json" path="/tasks" method="post" %}
4+
[https://lightswitch.gitbook.dev/openapi.json](https://lightswitch.gitbook.dev/openapi.json)
5+
{% endswagger %}
6+

docs/api/tasks/tasks.put.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# PUT /tasks
2+
3+
{% swagger src="https://lightswitch.gitbook.dev/openapi.json" path="/tasks" method="put" %}
4+
[https://lightswitch.gitbook.dev/openapi.json](https://lightswitch.gitbook.dev/openapi.json)
5+
{% endswagger %}
6+

docs/api/users/users.get.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# GET /users
2+
3+
{% swagger src="https://lightswitch.gitbook.dev/openapi.json" path="/users" method="get" %}
4+
[https://lightswitch.gitbook.dev/openapi.json](https://lightswitch.gitbook.dev/openapi.json)
5+
{% endswagger %}
6+

docs/api/users/users.post.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# POST /users
2+
3+
{% swagger src="https://lightswitch.gitbook.dev/openapi.json" path="/users" method="post" %}
4+
[https://lightswitch.gitbook.dev/openapi.json](https://lightswitch.gitbook.dev/openapi.json)
5+
{% endswagger %}
6+

docs/lightswitch/README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
icon: hand-wave
3+
---
4+
5+
# Welcome
6+
7+
Welcome to **LightSwitch**, your ultimate SaaS solution for productivity management. With LightSwitch, you can seamlessly manage tasks, track progress, and boost your productivity.
8+
9+
### Get Started
10+
11+
To begin using LightSwitch, sign up for an account and explore the intuitive dashboard to organize your workflow effortlessly.
12+
13+
### Features
14+
15+
* **Task Management:** Create, assign, and monitor tasks with ease.
16+
* **Progress Tracking:** Visualize your progress with dynamic charts.
17+
* **Collaborative Workspace:** Share and collaborate with your team in real-time.
18+
19+
### API Reference
20+
21+
Leverage our comprehensive API to integrate LightSwitch with your existing tools and streamline your productivity processes. Access the API documentation here to learn more about endpoints, authentication, and more.
22+
23+
We are excited to have you on board! For support, visit our Help Center or contact us at [email protected].

0 commit comments

Comments
 (0)