refact: added the main in readme.md
Browse files- docs/api_endpoints.md +1 -0
- docs/deployment.md +1 -0
- docs/functions.md +4 -0
- docs/nestjs_integration.md +3 -0
- docs/security.md +1 -0
- docs/setup.md +3 -0
- docs/structure.md +1 -1
docs/api_endpoints.md
CHANGED
|
@@ -72,4 +72,5 @@ curl -X POST http://localhost:8000/NP/upload \
|
|
| 72 |
-H "Authorization: Bearer <SECRET_TOKEN>" \
|
| 73 |
-F 'file=@NepaliText.pdf;type=application/pdf'
|
| 74 |
```
|
|
|
|
| 75 |
|
|
|
|
| 72 |
-H "Authorization: Bearer <SECRET_TOKEN>" \
|
| 73 |
-F 'file=@NepaliText.pdf;type=application/pdf'
|
| 74 |
```
|
| 75 |
+
- [Main](../readme.md)
|
| 76 |
|
docs/deployment.md
CHANGED
|
@@ -100,6 +100,7 @@ CMD ["uvicorn", "app:app", "--host", "0.0.0.0", "--port", "7860"]
|
|
| 100 |
* SpaCy Models: [https://spacy.io/models](https://spacy.io/models)
|
| 101 |
|
| 102 |
---
|
|
|
|
| 103 |
|
| 104 |
Happy deploying!
|
| 105 |
**P.S.** Try not to break stuff. 😅
|
|
|
|
| 100 |
* SpaCy Models: [https://spacy.io/models](https://spacy.io/models)
|
| 101 |
|
| 102 |
---
|
| 103 |
+
- [Main](../readme.md)
|
| 104 |
|
| 105 |
Happy deploying!
|
| 106 |
**P.S.** Try not to break stuff. 😅
|
docs/functions.md
CHANGED
|
@@ -51,3 +51,7 @@
|
|
| 51 |
Like `handle_file_sentence()`—analyzes sentences in uploaded files.
|
| 52 |
|
| 53 |
## for image_classifier
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 51 |
Like `handle_file_sentence()`—analyzes sentences in uploaded files.
|
| 52 |
|
| 53 |
## for image_classifier
|
| 54 |
+
|
| 55 |
+
|
| 56 |
+
- [Main](../readme.md)
|
| 57 |
+
|
docs/nestjs_integration.md
CHANGED
|
@@ -80,3 +80,6 @@ export class AppController {
|
|
| 80 |
}
|
| 81 |
}
|
| 82 |
```
|
|
|
|
|
|
|
|
|
|
|
|
| 80 |
}
|
| 81 |
}
|
| 82 |
```
|
| 83 |
+
|
| 84 |
+
- [Main](../readme.md)
|
| 85 |
+
|
docs/security.md
CHANGED
|
@@ -6,4 +6,5 @@ All endpoints require authentication via Bearer token:
|
|
| 6 |
- Add header: `Authorization: Bearer <SECRET_TOKEN>`
|
| 7 |
|
| 8 |
Unauthorized requests receive `403 Forbidden`.
|
|
|
|
| 9 |
|
|
|
|
| 6 |
- Add header: `Authorization: Bearer <SECRET_TOKEN>`
|
| 7 |
|
| 8 |
Unauthorized requests receive `403 Forbidden`.
|
| 9 |
+
- [Main](../readme.md)
|
| 10 |
|
docs/setup.md
CHANGED
|
@@ -21,3 +21,6 @@ SECRET_TOKEN=your_secret_token_here
|
|
| 21 |
```bash
|
| 22 |
uvicorn app:app --host 0.0.0.0 --port 8000
|
| 23 |
```
|
|
|
|
|
|
|
|
|
|
|
|
| 21 |
```bash
|
| 22 |
uvicorn app:app --host 0.0.0.0 --port 8000
|
| 23 |
```
|
| 24 |
+
|
| 25 |
+
- [Main](../readme.md)
|
| 26 |
+
|
docs/structure.md
CHANGED
|
@@ -51,4 +51,4 @@
|
|
| 51 |
|
| 52 |
|
| 53 |
|
| 54 |
-
-[Main](../
|
|
|
|
| 51 |
|
| 52 |
|
| 53 |
|
| 54 |
+
- [Main](../readme.md)
|