Skip to content

Commit 73af8da

Browse files
committed
docs: complete documentation overhaul with accuracy fixes
- Replace 5 overlapping docs with 4 focused guides - Add getting-started.md (actionable user onboarding) - Add developer-guide.md (streamlined technical docs) - Update api-guide.md with Coming Soon banner - Keep import-guide.md (already accurate) - Delete business-guide.md, quick-start-guide.md, technical-guide.md - Fix inaccuracies: auth is Jetstream not Fortify - Fix inaccuracies: Task/Note use morphToMany relationships - Remove non-existent keyboard shortcuts - Update config and icon mappings
1 parent 66284a4 commit 73af8da

File tree

8 files changed

+406
-753
lines changed

8 files changed

+406
-753
lines changed

app-modules/Documentation/config/documentation.php

Lines changed: 12 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -39,30 +39,25 @@
3939
|
4040
*/
4141
'documents' => [
42-
'business' => [
43-
'title' => 'Business Guide',
44-
'file' => 'business-guide.md',
45-
'description' => 'Documentation for business users and stakeholders.',
46-
],
47-
'technical' => [
48-
'title' => 'Technical Guide',
49-
'file' => 'technical-guide.md',
50-
'description' => 'Technical documentation for developers and system administrators.',
51-
],
52-
'quickstart' => [
53-
'title' => 'Quick Start Guide',
54-
'file' => 'quick-start-guide.md',
55-
'description' => 'Get started quickly with essential information.',
42+
'getting-started' => [
43+
'title' => 'Getting Started',
44+
'file' => 'getting-started.md',
45+
'description' => 'Set up your account and learn the basics.',
5646
],
5747
'import' => [
5848
'title' => 'Import Guide',
5949
'file' => 'import-guide.md',
60-
'description' => 'Complete guide for importing companies, people, opportunities, tasks, and notes into Relaticle.',
50+
'description' => 'Import data from CSV files.',
51+
],
52+
'developer' => [
53+
'title' => 'Developer Guide',
54+
'file' => 'developer-guide.md',
55+
'description' => 'Installation, architecture, and contributing.',
6156
],
6257
'api' => [
63-
'title' => 'API Documentation',
58+
'title' => 'API Reference',
6459
'file' => 'api-guide.md',
65-
'description' => 'API reference and integration documentation.',
60+
'description' => 'REST API documentation (coming soon).',
6661
],
6762
],
6863

Lines changed: 50 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,67 +1,71 @@
1-
# API Documentation
1+
# API Reference
22

3-
This guide provides documentation for the Relaticle API, allowing developers to integrate Relaticle's CRM capabilities with other applications.
3+
> **Coming Soon** — The REST API is under active development.
44
5-
## API Overview
5+
---
66

7-
Relaticle's API is currently under development. This section will be updated with comprehensive documentation once the API is available for use.
7+
## Overview
88

9-
## Planned API Features
9+
Relaticle will provide a comprehensive REST API for integrating with external applications and building custom workflows.
1010

11-
The Relaticle API will include:
11+
---
1212

13-
- REST API endpoints for all major resources (Companies, Contacts, Opportunities, Tasks, Notes)
14-
- Authentication via API tokens
15-
- Comprehensive query capabilities
16-
- Pagination and filtering options
13+
## Planned Features
1714

18-
## Authentication
15+
| Feature | Description |
16+
|---------|-------------|
17+
| **Authentication** | API tokens via Laravel Sanctum |
18+
| **CRUD Endpoints** | Companies, People, Opportunities, Tasks, Notes |
19+
| **Filtering** | Query parameters for filtering and searching |
20+
| **Pagination** | Cursor-based pagination for large datasets |
21+
| **Rate Limiting** | Fair usage limits per token |
1922

20-
Our authentication system will use API tokens for secure access to the API.
23+
---
2124

22-
## Core Resources
25+
## Planned Endpoints
2326

24-
The API will provide access to the following resources:
27+
```
28+
GET /api/companies
29+
POST /api/companies
30+
GET /api/companies/{id}
31+
PUT /api/companies/{id}
32+
DELETE /api/companies/{id}
2533
26-
### Companies
34+
GET /api/people
35+
POST /api/people
36+
GET /api/people/{id}
37+
PUT /api/people/{id}
38+
DELETE /api/people/{id}
2739
28-
The Companies endpoint will allow you to:
29-
- List companies
30-
- Retrieve company details
31-
- Create new companies
32-
- Update existing companies
33-
- Delete companies
40+
GET /api/opportunities
41+
POST /api/opportunities
42+
GET /api/opportunities/{id}
43+
PUT /api/opportunities/{id}
44+
DELETE /api/opportunities/{id}
3445
35-
### Contacts (People)
46+
GET /api/tasks
47+
POST /api/tasks
48+
GET /api/tasks/{id}
49+
PUT /api/tasks/{id}
50+
DELETE /api/tasks/{id}
3651
37-
The Contacts endpoint will allow you to:
38-
- List contacts
39-
- Retrieve contact details
40-
- Create new contacts
41-
- Update existing contacts
42-
- Delete contacts
52+
GET /api/notes
53+
POST /api/notes
54+
GET /api/notes/{id}
55+
PUT /api/notes/{id}
56+
DELETE /api/notes/{id}
57+
```
4358

44-
### Opportunities
59+
---
4560

46-
The Opportunities endpoint will allow you to:
47-
- List opportunities
48-
- Retrieve opportunity details
49-
- Create new opportunities
50-
- Update existing opportunities
51-
- Delete opportunities
61+
## Stay Updated
5262

53-
### Tasks
63+
Follow the repository for release announcements:
5464

55-
The Tasks endpoint will provide similar CRUD operations for tasks.
65+
[github.com/Relaticle/relaticle](https://github.com/Relaticle/relaticle)
5666

57-
### Notes
67+
---
5868

59-
The Notes endpoint will provide similar CRUD operations for notes.
69+
## Have Suggestions?
6070

61-
## API Release Timeline
62-
63-
We are actively working on our API. If you would like to be notified when it becomes available, please follow our GitHub repository for updates.
64-
65-
## Contributing
66-
67-
If you have suggestions for our upcoming API, please open an issue in our GitHub repository with your ideas and requirements.
71+
Open an issue on GitHub to share your API requirements and use cases.

app-modules/Documentation/resources/markdown/business-guide.md

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

0 commit comments

Comments
 (0)