Skip to content

Commit b6649cc

Browse files
tisniktisnik
authored
Merge pull request #2158 from tisnik/lcore-2933-2
LCORE-2933: User doc
2 parents fe5908e + 0e44b65 commit b6649cc

16 files changed

Lines changed: 38 additions & 28 deletions

‎docs/README.md‎

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ See the full documentation at [`../README.md`](../README.md) or browse sub-pages
88
<!-- vim-markdown-toc GFM -->
99

1010
* [Basic info](#basic-info)
11+
* [User docs](#user-docs)
1112
* [Overview](#overview)
1213
* [Installation and configuration](#installation-and-configuration)
1314
* [Status of Lightspeed Core Stack versions](#status-of-lightspeed-core-stack-versions)
@@ -39,26 +40,39 @@ See the full documentation at [`../README.md`](../README.md) or browse sub-pages
3940

4041
[Getting started](https://lightspeed-core.github.io/lightspeed-stack/basic_info/getting_started.html)
4142

43+
## User docs
44+
45+
[Deployment Guide](https://lightspeed-core.github.io/lightspeed-stack/user_doc/deployment_guide.html)
46+
47+
[Configuration options](https://lightspeed-core.github.io/lightspeed-stack/user_doc/config.html)
48+
49+
[Agent skills](https://lightspeed-core.github.io/lightspeed-stack/user_doc/skills_guide.html)
50+
51+
[A2A [Agent-to-Agent] Protocol](https://lightspeed-core.github.io/lightspeed-stack/user_doc/a2a_protocol.html)
52+
53+
[RAG configuration guide](https://lightspeed-core.github.io/lightspeed-stack/user_doc/rag_guide.html)
54+
55+
[BYOK guide](https://lightspeed-core.github.io/lightspeed-stack/user_doc/byok_guide.html)
56+
57+
[Authentication and Authorization](https://lightspeed-core.github.io/lightspeed-stack/user_doc/auth.html)
58+
59+
[User data collection](https://lightspeed-core.github.io/lightspeed-stack/user_doc/user_data_collection.html)
60+
4261
## Overview
4362

4463
[Architecture](https://lightspeed-core.github.io/lightspeed-stack/ARCHITECTURE.html)
4564

4665
[Architecture diagram](https://lightspeed-core.github.io/lightspeed-stack/architecture.svg)
4766

48-
[Authentication and Authorization](https://lightspeed-core.github.io/lightspeed-stack/auth.html)
49-
5067
## Installation and configuration
5168

52-
[Deployment Guide](https://lightspeed-core.github.io/lightspeed-stack/deployment_guide.html)
5369

5470
[Container Orchestration Guide](https://lightspeed-core.github.io/lightspeed-stack/container_orchestration.html)
5571

5672
[Linux](https://lightspeed-core.github.io/lightspeed-stack/installation_linux.html)
5773

5874
[MacOS](https://lightspeed-core.github.io/lightspeed-stack/installation_macos.html)
5975

60-
[Configuration](https://lightspeed-core.github.io/lightspeed-stack/config.html)
61-
6276
## Status of Lightspeed Core Stack versions
6377

6478
[Status of Lightspeed Core Stack versions](https://lightspeed-core.github.io/lightspeed-stack/version_status.html)
@@ -81,26 +95,17 @@ See the full documentation at [`../README.md`](../README.md) or browse sub-pages
8195

8296
[Conversations API](https://lightspeed-core.github.io/lightspeed-stack/conversations_api.html)
8397

84-
[A2A [Agent-to-Agent] Protocol](https://lightspeed-core.github.io/lightspeed-stack/a2a_protocol.html)
85-
8698
## RAG and BYOK
8799

88-
[RAG Configuration Guide](https://lightspeed-core.github.io/lightspeed-stack/rag_guide.html)
89-
90-
[BYOK guide](https://lightspeed-core.github.io/lightspeed-stack/byok_guide.html)
91-
92100
## Other features
93101

94102
[Providers](https://lightspeed-core.github.io/lightspeed-stack/providers.html)
95103

96104
[Sentry error tracking](https://lightspeed-core.github.io/lightspeed-stack/sentry.html)
97105

98-
[User data collection](https://lightspeed-core.github.io/lightspeed-stack/user_data_collection.html)
99106

100107
[Database structure](https://lightspeed-core.github.io/lightspeed-stack/DB/index.html)
101108

102-
[Agent skills](https://lightspeed-core.github.io/lightspeed-stack/skills_guide.html)
103-
104109
## Models
105110

106111
[Common](https://lightspeed-core.github.io/lightspeed-stack/models/common.html)

‎docs/index.md‎

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ product questions using backend LLM services, agents, and RAG databases.
1515
<!-- vim-markdown-toc GFM -->
1616

1717
* [Basic info](#basic-info)
18+
* [User docs](#user-docs)
1819
* [Overview](#overview)
1920
* [Installation and configuration](#installation-and-configuration)
2021
* [Status of Lightspeed Core Stack versions](#status-of-lightspeed-core-stack-versions)
@@ -46,26 +47,39 @@ product questions using backend LLM services, agents, and RAG databases.
4647

4748
[Getting started](https://lightspeed-core.github.io/lightspeed-stack/basic_info/getting_started.html)
4849

50+
## User docs
51+
52+
[Deployment Guide](https://lightspeed-core.github.io/lightspeed-stack/user_doc/deployment_guide.html)
53+
54+
[Configuration options](https://lightspeed-core.github.io/lightspeed-stack/user_doc/config.html)
55+
56+
[Agent skills](https://lightspeed-core.github.io/lightspeed-stack/user_doc/skills_guide.html)
57+
58+
[A2A [Agent-to-Agent] Protocol](https://lightspeed-core.github.io/lightspeed-stack/user_doc/a2a_protocol.html)
59+
60+
[RAG configuration guide](https://lightspeed-core.github.io/lightspeed-stack/user_doc/rag_guide.html)
61+
62+
[BYOK guide](https://lightspeed-core.github.io/lightspeed-stack/user_doc/byok_guide.html)
63+
64+
[Authentication and Authorization](https://lightspeed-core.github.io/lightspeed-stack/user_doc/auth.html)
65+
66+
[User data collection](https://lightspeed-core.github.io/lightspeed-stack/user_doc/user_data_collection.html)
67+
4968
## Overview
5069

5170
[Architecture](https://lightspeed-core.github.io/lightspeed-stack/ARCHITECTURE.html)
5271

5372
[Architecture diagram](https://lightspeed-core.github.io/lightspeed-stack/architecture.svg)
5473

55-
[Authentication and Authorization](https://lightspeed-core.github.io/lightspeed-stack/auth.html)
56-
5774
## Installation and configuration
5875

59-
[Deployment Guide](https://lightspeed-core.github.io/lightspeed-stack/deployment_guide.html)
6076

6177
[Container Orchestration Guide](https://lightspeed-core.github.io/lightspeed-stack/container_orchestration.html)
6278

6379
[Linux](https://lightspeed-core.github.io/lightspeed-stack/installation_linux.html)
6480

6581
[MacOS](https://lightspeed-core.github.io/lightspeed-stack/installation_macos.html)
6682

67-
[Configuration](https://lightspeed-core.github.io/lightspeed-stack/config.html)
68-
6983
## Status of Lightspeed Core Stack versions
7084

7185
[Status of Lightspeed Core Stack versions](https://lightspeed-core.github.io/lightspeed-stack/version_status.html)
@@ -88,26 +102,17 @@ product questions using backend LLM services, agents, and RAG databases.
88102

89103
[Conversations API](https://lightspeed-core.github.io/lightspeed-stack/conversations_api.html)
90104

91-
[A2A [Agent-to-Agent] Protocol](https://lightspeed-core.github.io/lightspeed-stack/a2a_protocol.html)
92-
93105
## RAG and BYOK
94106

95-
[RAG Configuration Guide](https://lightspeed-core.github.io/lightspeed-stack/rag_guide.html)
96-
97-
[BYOK guide](https://lightspeed-core.github.io/lightspeed-stack/byok_guide.html)
98-
99107
## Other features
100108

101109
[Providers](https://lightspeed-core.github.io/lightspeed-stack/providers.html)
102110

103111
[Sentry error tracking](https://lightspeed-core.github.io/lightspeed-stack/sentry.html)
104112

105-
[User data collection](https://lightspeed-core.github.io/lightspeed-stack/user_data_collection.html)
106113

107114
[Database structure](https://lightspeed-core.github.io/lightspeed-stack/DB/index.html)
108115

109-
[Agent skills](https://lightspeed-core.github.io/lightspeed-stack/skills_guide.html)
110-
111116
## Models
112117

113118
[Common](https://lightspeed-core.github.io/lightspeed-stack/models/common.html)

‎docs/user_doc/README.md‎

Whitespace-only changes.

docs/a2a_protocol.md renamed to docs/user_doc/a2a_protocol.md

File renamed without changes.

docs/auth.md renamed to docs/user_doc/auth.md

File renamed without changes.

docs/byok_guide.md renamed to docs/user_doc/byok_guide.md

File renamed without changes.

docs/config.html renamed to docs/user_doc/config.html

File renamed without changes.

docs/config.json renamed to docs/user_doc/config.json

File renamed without changes.

docs/config.md renamed to docs/user_doc/config.md

File renamed without changes.

docs/config.png renamed to docs/user_doc/config.png

File renamed without changes.

0 commit comments

Comments
 (0)