Skip to content

Commit 872b2b2

Browse files
committed
Add markdown generation to deploy workflow, document LLM resources and TinyMCE 8 in README
1 parent b07a584 commit 872b2b2

2 files changed

Lines changed: 19 additions & 1 deletion

File tree

.github/workflows/deploy_docs_v2.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,9 @@ jobs:
5353
- name: Copy llms.txt files to root
5454
run: ./-scripts/copy-llms-files.sh build/site
5555

56+
- name: Generate markdown for agents
57+
run: yarn build:markdown build/site
58+
5659
- name: Rename site folder to docs
5760
run: |
5861
mv ./build/site ./build/docs

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# TinyMCE Documentation
22

3-
This project maintains the official documentation for TinyMCE, available at [https://www.tiny.cloud/docs](https://www.tiny.cloud/docs). If you have modifications or improvements to contribute, fork this repository, make the necessary changes, and submit a pull request (PR). A contributor's license agreement (CLA) must be signed before your contribution can be merged. This agreement will be sent via email when you create a PR.
3+
This project maintains the official documentation for TinyMCE, available at [https://www.tiny.cloud/docs](https://www.tiny.cloud/docs). **TinyMCE 8 is the current stable version.** Use `tinymce@8` or `tinymce/8` in CDN URLs and package installations for new projects.
4+
5+
If you have modifications or improvements to contribute, fork this repository, make the necessary changes, and submit a pull request (PR). A contributor's license agreement (CLA) must be signed before your contribution can be merged. This agreement will be sent via email when you create a PR.
46

57
This project is built using [Antora](https://antora.org/)
68

@@ -99,3 +101,16 @@ To help with this, there are two mechanisms for overriding the `tinymce.min.js`
99101
```
100102
101103
> **Caution:** Use this sparingly. Avoid using different URLs for multiple demos on the same page, and remember to revert these changes once the feature is fully released.
104+
105+
## Resources for AI and LLM Consumers
106+
107+
The published documentation site provides several artifacts optimized for AI agents and LLM-based tools:
108+
109+
| Resource | URL | Description |
110+
|----------|-----|--------------|
111+
| `llms.txt` | [https://www.tiny.cloud/docs/llms.txt](https://www.tiny.cloud/docs/llms.txt) | Concise overview with key links and code examples |
112+
| `llms-full.txt` | [https://www.tiny.cloud/docs/llms-full.txt](https://www.tiny.cloud/docs/llms-full.txt) | Full index of documentation pages with URLs |
113+
114+
**Version guidance:** Always prefer TinyMCE 8 for new projects. The `/tinymce/latest/` URL segment serves TinyMCE 8 content. Use `tinymce@8` or `tinymce/8` in CDN URLs and package installations.
115+
116+
In addition, each HTML page has a Markdown sibling (`.md`) for content negotiation. Clients that send `Accept: text/markdown` can request plain markdown instead of HTML for lower-token consumption. These markdown files are generated during deployment and are not produced by local builds or PR previews.

0 commit comments

Comments
 (0)