Skip to content

Commit 9c2f1a0

Browse files
committed
edit contribution docs
1 parent a360ff9 commit 9c2f1a0

7 files changed

Lines changed: 54 additions & 13 deletions

File tree

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Contributing
22

3-
Contributions are always welcome, no matter how large or small. Before contributing,
3+
Contributions are always welcome. Before contributing,
44
please read the [code of conduct](CODE_OF_CONDUCT.md).
55

6-
Some thoughts to help you contribute to this project
6+
Some thoughts to help you contribute to this project:
77

88
## General Recommendations
99

@@ -136,7 +136,7 @@ For detailed documentation on specific systems, see the [Contribution Guide](./d
136136

137137
## Funding
138138

139-
LiveCodes is a part of GitHub Sponsors. If you would like to contribute, please note the [sponsor page](https://livecodes.io/docs/sponsor) for details.
139+
LiveCodes is a part of GitHub Sponsors. If you would like to support the project, please refer to the [sponsor page](https://livecodes.io/docs/sponsor) for details.
140140

141141
## License
142142

docs/docs/ai-agents.mdx

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# For AI Agents
2+
3+
### llms.txt
4+
5+
For developers working with AI agents and language models, we provide specialized documentation files following the [llms.txt specification](https://llmstxt.org/):
6+
7+
- [llms.txt](pathname:///llms.txt) - Concise documentation optimized for LLM context windows
8+
- [llms-full.txt](pathname:///llms-full.txt) - Comprehensive documentation including all referenced URLs
9+
10+
These files provide LLM-friendly content in a standardized format, helping language models understand and work with LiveCodes documentation. The format is designed to be both human and LLM readable.
11+
12+
### Intent Skills
13+
14+
If you use an AI coding agent, run:
15+
16+
```bash
17+
npx @tanstack/intent@latest install
18+
```
19+
20+
This loads the Intent skills for LiveCodes SDK. See [skill index](https://github.com/live-codes/livecodes/blob/HEAD/skills/livecodes/SKILL.md).
21+
22+
### System Documentation
23+
24+
The internal architecture and system documentation are detailed in the [contribution guide](https://github.com/live-codes/livecodes/blob/HEAD/docs/docs/contribution/README.md).
25+

docs/docs/contribution.mdx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
# Contribution
22

3-
Contributions are always welcome, no matter how large or small. Before contributing,
3+
Contributions are always welcome. Before contributing,
44
please read the [code of conduct](https://github.com/live-codes/livecodes/blob/HEAD/CODE_OF_CONDUCT.md).
55

6-
For code contribution, please refer to the [contribution guide](https://github.com/live-codes/livecodes/blob/HEAD/CONTRIBUTING.md)
7-
.
6+
For code contribution, please refer to the [contribution introduction](https://github.com/live-codes/livecodes/blob/HEAD/CONTRIBUTING.md).
7+
The internal architecture and system documentation are detailed in the [contribution guide](https://github.com/live-codes/livecodes/blob/HEAD/docs/docs/contribution/README.md).
8+
9+
For AI agents, see the section [For AI Agents](./ai-agents.mdx).
810

911
For financial and in-kind contributions, please refer to the [sponsor page](./sponsor.mdx).
1012

docs/docs/contribution/README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,18 +49,23 @@ This directory contains comprehensive documentation for contributors working on
4949

5050
### Services & Infrastructure
5151

52-
| Document | Description |
53-
| -------------------------------------------- | ----------------------------------------------------------- |
54-
| [services-system.mdx](./services-system.mdx) | External services: auth, share, CDN resolution, CORS proxy |
55-
| [build-system.mdx](./build-system.mdx) | Build scripts, outputs, and development workflow |
56-
| [sdk.mdx](./sdk.mdx) | SDK architecture, framework wrappers, and API communication |
52+
| Document | Description |
53+
| -------------------------------------------- | ---------------------------------------------------------- |
54+
| [services-system.mdx](./services-system.mdx) | External services: auth, share, CDN resolution, CORS proxy |
55+
| [build-system.mdx](./build-system.mdx) | Build scripts, outputs, and development workflow |
5756

5857
### Internationalization
5958

6059
| Document | Description |
6160
| ---------------------- | ---------------------------------------------------------------- |
6261
| [i18n.mdx](./i18n.mdx) | Translation workflow, Lokalise integration, and script reference |
6362

63+
### SDK
64+
65+
| Document | Description |
66+
| -------------------- | ----------------------------------------------------------- |
67+
| [sdk.mdx](./sdk.mdx) | SDK architecture, framework wrappers, and API communication |
68+
6469
### Testing & Development
6570

6671
| Document | Description |

docs/docusaurus.config.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,8 @@ const config: Config = {
168168
to: '/bookmarklet',
169169
},
170170
{
171-
html: `<span style="display: flex; gap: 0.5em; align-items: baseline;"><a href="/docs/llms.txt" target="_blank" class="footer__link-item">llms.txt</a>-<a href="/docs/llms-full.txt" target="_blank" class="footer__link-item">llms-full.txt</a></span>`,
171+
label: 'For AI Agents',
172+
to: '/ai-agents',
172173
},
173174
],
174175
},

docs/sidebars.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,7 @@ const sidebars: SidebarsConfig = {
132132
'gh-action',
133133
'markdown-to-livecodes',
134134
'contribution',
135+
'ai-agents',
135136
'credits',
136137
'license',
137138
'sponsor',

src/sdk/package.sdk.json

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,5 +60,12 @@
6060
"types": "./types/web-components.d.ts"
6161
},
6262
"./package.json": "./package.json"
63-
}
63+
},
64+
"funding": [
65+
"https://github.com/sponsors/live-codes",
66+
"https://github.com/sponsors/hatemhosny",
67+
"https://ko-fi.com/hatemhosny",
68+
"https://paypal.me/hatemhosni",
69+
"https://livecodes.io/docs/sponsor"
70+
]
6471
}

0 commit comments

Comments
 (0)