-
Notifications
You must be signed in to change notification settings - Fork 112
docs: add LLMs.txt and Changelog section #645
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Changes from 15 commits
Commits
Show all changes
21 commits
Select commit
Hold shift + click to select a range
6895c9d
Setup
orionmiz f1cb971
correct branch name
orionmiz c6a3c8a
generate ko doc
orionmiz 627c24d
ignore type error
orionmiz 4bdbeb0
title by locale
orionmiz a464d00
remove symlink
orionmiz 8bb8f8f
re add ko locale
orionmiz f962de9
feat: insert txts at build time
orionmiz f9b52b5
yarn
orionmiz 3957b0a
remove prefix
orionmiz af6e8f4
change directory structure
orionmiz 24a76a3
remove unused meta
orionmiz b1f6d1b
eol
orionmiz d4d31ef
remove tsconfig
orionmiz d7266b7
move changelog script into docs
orionmiz 61c662e
resolve lock
orionmiz 7f3eeca
dedupe changelog
orionmiz 8476826
Merge branch 'main' into llms-txt
orionmiz 5046550
remove root package json's module type
orionmiz 6382698
keep manual content on regeneration
orionmiz 73fc502
remove unix pipeline
orionmiz File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| "@stackflow/docs": minor | ||
| --- | ||
|
|
||
| Add LLMs.txt and changelog section |
Large diffs are not rendered by default.
Oops, something went wrong.
Binary file added
BIN
+42.9 KB
.yarn/cache/@changesets-assemble-release-plan-npm-6.0.9-e01af97ef4-f84656eabb.zip
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added
BIN
+10.4 KB
.yarn/cache/mdast-util-find-and-replace-npm-3.0.2-700884f061-446561aa95.zip
Binary file not shown.
Binary file added
BIN
+26.2 KB
.yarn/cache/mdast-util-from-markdown-npm-2.0.2-b327f875e3-69b207913f.zip
Binary file not shown.
Binary file added
BIN
+8.54 KB
.yarn/cache/mdast-util-gfm-autolink-literal-npm-2.0.1-dd870d9308-d933b42feb.zip
Binary file not shown.
Binary file added
BIN
+9.24 KB
.yarn/cache/mdast-util-gfm-footnote-npm-2.1.0-d8da32ba7c-5fac0f64d1.zip
Binary file not shown.
Binary file not shown.
Binary file added
BIN
+7.6 KB
.yarn/cache/mdast-util-gfm-strikethrough-npm-2.0.0-d16d95c318-b1abc137d7.zip
Binary file not shown.
Binary file not shown.
Binary file added
BIN
+7.61 KB
.yarn/cache/mdast-util-gfm-task-list-item-npm-2.0.0-cb1270a10f-679a3ff09b.zip
Binary file not shown.
Binary file not shown.
Binary file added
BIN
+88.5 KB
.yarn/cache/mdast-util-to-markdown-npm-2.1.2-40d984eac3-ab494a32f1.zip
Binary file not shown.
Binary file not shown.
Binary file added
BIN
+97.8 KB
.yarn/cache/micromark-core-commonmark-npm-2.0.3-5e317c62b2-2b98b9eba1.zip
Binary file not shown.
Binary file added
BIN
+21.4 KB
.yarn/cache/micromark-extension-gfm-autolink-literal-npm-2.1.0-8fcb271412-933b9b96ca.zip
Binary file not shown.
Binary file added
BIN
+26.6 KB
.yarn/cache/micromark-extension-gfm-footnote-npm-2.1.0-1cf783dd36-7e019414e3.zip
Binary file not shown.
Binary file added
BIN
+7.25 KB
.yarn/cache/micromark-extension-gfm-npm-3.0.0-d154ab531f-8493d10417.zip
Binary file not shown.
Binary file added
BIN
+13.5 KB
.yarn/cache/micromark-extension-gfm-strikethrough-npm-2.1.0-b2aa188eba-eaf2c7b1e3.zip
Binary file not shown.
Binary file added
BIN
+33.7 KB
.yarn/cache/micromark-extension-gfm-table-npm-2.1.1-7b9f4422c9-0391ead408.zip
Binary file not shown.
Binary file added
BIN
+6.44 KB
.yarn/cache/micromark-extension-gfm-tagfilter-npm-2.0.0-c5ad486636-c5e3f8cdf2.zip
Binary file not shown.
Binary file added
BIN
+12.6 KB
.yarn/cache/micromark-extension-gfm-task-list-item-npm-2.1.0-b717607894-c5f72929f0.zip
Binary file not shown.
Binary file added
BIN
+8.73 KB
.yarn/cache/micromark-factory-destination-npm-2.0.1-2b4ab89121-9c4baa9ca2.zip
Binary file not shown.
Binary file added
BIN
+8.46 KB
.yarn/cache/micromark-factory-label-npm-2.0.1-2ce9fdcfd2-bd03f5a75f.zip
Binary file not shown.
Binary file added
BIN
+7.98 KB
.yarn/cache/micromark-factory-space-npm-2.0.1-36b4717310-1bd68a017c.zip
Binary file not shown.
Binary file added
BIN
+7.97 KB
.yarn/cache/micromark-factory-title-npm-2.0.1-a5f7a4ac37-b4d2e4850a.zip
Binary file not shown.
Binary file added
BIN
+7.18 KB
.yarn/cache/micromark-factory-whitespace-npm-2.0.1-2d7cfaf8ae-67b3944d01.zip
Binary file not shown.
Binary file not shown.
Binary file added
BIN
+8.51 KB
.yarn/cache/micromark-util-chunked-npm-2.0.1-27444b1e7b-f8cb2a67bc.zip
Binary file not shown.
Binary file added
BIN
+7.09 KB
.yarn/cache/micromark-util-classify-character-npm-2.0.1-127a4a9c2a-4d8bbe3a6d.zip
Binary file not shown.
Binary file added
BIN
+5.7 KB
.yarn/cache/micromark-util-combine-extensions-npm-2.0.1-9810c0bf8d-5d22fb9ee3.zip
Binary file not shown.
Binary file added
BIN
+7.33 KB
...che/micromark-util-decode-numeric-character-reference-npm-2.0.2-c2d481632e-ee11c8bde5.zip
Binary file not shown.
Binary file added
BIN
+6.8 KB
.yarn/cache/micromark-util-decode-string-npm-2.0.1-72716f39ea-2f517e4c61.zip
Binary file not shown.
Binary file added
BIN
+5.64 KB
.yarn/cache/micromark-util-html-tag-name-npm-2.0.1-eb560993c8-dea365f5ad.zip
Binary file not shown.
Binary file added
BIN
+7.56 KB
.yarn/cache/micromark-util-normalize-identifier-npm-2.0.1-336335e80e-1eb9a289d7.zip
Binary file not shown.
Binary file added
BIN
+5.49 KB
.yarn/cache/micromark-util-resolve-all-npm-2.0.1-50f997ec4c-9275f3ddb6.zip
Binary file not shown.
Binary file added
BIN
+20.4 KB
.yarn/cache/micromark-util-subtokenize-npm-2.1.0-2452c9ae9b-5f18c70cb9.zip
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,6 @@ | ||
| /.next | ||
| /out | ||
| .open-next | ||
| .open-next | ||
|
|
||
| /public/llms-*.txt | ||
| /public/llms.txt |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,6 @@ | ||
| { | ||
| "get-started": "Get Started", | ||
| "advanced": "Advanced Usage" | ||
| "advanced": "Advanced Usage", | ||
| "ai-integration": "AI Integration", | ||
| "changelog": "Changelog" | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,6 @@ | ||
| { | ||
| "get-started": "시작하기", | ||
| "advanced": "활용하기" | ||
| "advanced": "활용하기", | ||
| "ai-integration": "AI 통합", | ||
| "changelog": "변경 이력" | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| { | ||
| "llms-txt": "LLMs.txt" | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| { | ||
| "llms-txt": "LLMs.txt" | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| --- | ||
| title: LLMs.txt | ||
| --- | ||
|
|
||
| # LLMs.txt | ||
|
|
||
| We provide an LLMs.txt setup to help large language models (LLMs) easily understand Stackflow. | ||
|
|
||
| ### Structure | ||
|
|
||
| We provide the following LLMs.txt files: | ||
|
|
||
| - [llms.txt](https://stackflow.so/llms.txt): The main file that describes the structure of all LLMs.txt files. | ||
| - [llms-full.txt](https://stackflow.so/llms-full.txt): Includes all Stackflow documentation. | ||
| - [llms-changelog.txt](https://stackflow.so/llms-changelog.txt): Contains the latest updates and changes so you can review version-by-version history. | ||
|
|
||
| ### Using with AI tools | ||
| #### Cursor | ||
| You can include the LLMs.txt files in your project using Cursor's @Docs feature. | ||
|
|
||
| [**Learn more about Cursor @Docs**](https://docs.cursor.com/context/@-symbols/@-docs) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| --- | ||
| title: LLMs.txt | ||
| --- | ||
|
|
||
| # LLMs.txt | ||
|
|
||
| 대규모 언어 모델(LLM)이 Stackflow를 쉽게 이해할 수 있도록 LLMs.txt를 제공합니다. | ||
|
|
||
| ### 구조 | ||
|
|
||
| 다음과 같은 LLMs.txt 파일들을 제공합니다: | ||
|
|
||
| - [llms.txt](https://stackflow.so/llms.txt): LLMs.txt 파일들의 구조를 제공하는 메인 파일입니다. | ||
| - [llms-full.txt](https://stackflow.so/llms-full.txt): Stackflow의 모든 문서를 포함합니다. | ||
| - [llms-changelog.txt](https://stackflow.so/llms-changelog.txt): 최신 업데이트와 변경사항을 포함하여 버전별 변경 내역을 확인할 수 있습니다. | ||
|
|
||
| ### AI 도구와 함께 사용하기 | ||
| #### Cursor | ||
| Cursor의 @Docs 기능을 사용하여 프로젝트에 LLMs.txt 파일을 포함할 수 있습니다. | ||
|
|
||
| [**Cursor @Docs에 대해 자세히 알아보기**](https://docs.cursor.com/context/@-symbols/@-docs) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| --- | ||
| title: Changelog | ||
| --- | ||
|
|
||
| ## 2025.10.24 #2 | ||
|
|
||
| Add LLMs.txt and changelog section | ||
|
|
||
| Released packages: | ||
| - 📦 [@stackflow/docs@2.1.0](https://npmjs.com/package/@stackflow/docs/v/2.1.0) | ||
|
|
||
| --- | ||
|
|
||
| ## 2025.10.24 | ||
|
|
||
| Add LLMs.txt and changelog section | ||
|
|
||
| Released packages: | ||
| - 📦 [@stackflow/docs@2.1.0](https://npmjs.com/package/@stackflow/docs/v/2.1.0) | ||
|
|
||
| --- | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| --- | ||
| title: Changelog | ||
| --- | ||
|
|
||
| ## 2025.10.24 #2 | ||
|
|
||
| Add LLMs.txt and changelog section | ||
|
|
||
| Released packages: | ||
| - 📦 [@stackflow/docs@2.1.0](https://npmjs.com/package/@stackflow/docs/v/2.1.0) | ||
|
|
||
| --- | ||
|
|
||
| ## 2025.10.24 | ||
|
|
||
| Add LLMs.txt and changelog section | ||
|
|
||
| Released packages: | ||
| - 📦 [@stackflow/docs@2.1.0](https://npmjs.com/package/@stackflow/docs/v/2.1.0) | ||
coderabbitai[bot] marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| --- | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.