CodeCow/stack
1
0
Fork 0
mirror of https://github.com/stack-auth/stack.git synced 2026-06-04 21:04:37 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
48c6f47448
stack/docs
History
Madison 48c6f47448
Add API docs to llms.txt file. (#766) 
<!--

Make sure you've read the CONTRIBUTING.md guidelines:
https://github.com/stack-auth/stack-auth/blob/dev/CONTRIBUTING.md

-->

Adds API docs to the llms.txt file for our agent to reference. Before,
it was not capturing this information about the API.

<!-- ELLIPSIS_HIDDEN -->

----

> [!IMPORTANT]
> Adds OpenAPI documentation extraction and formatting to
`get-llm-text.ts` and updates Next.js configuration for ESLint and
OpenAPI file handling.
> 
>   - **Behavior**:
> - Adds `extractOpenAPIContent()` in `get-llm-text.ts` to extract
OpenAPI content from API pages.
> - Formats OpenAPI operations and specs using `formatOperation()` and
`formatOpenAPISpec()`.
> - Updates `getLLMText()` to return formatted OpenAPI content if
available.
>   - **Configuration**:
> - Changes `ignoreDuringBuilds` to `false` in `next.config.mjs` to
enable ESLint during builds.
> - Includes OpenAPI files in `outputFileTracingIncludes` for Vercel
deployments in `next.config.mjs`.
> 
> <sup>This description was created by </sup>[<img alt="Ellipsis"
src="https://img.shields.io/badge/Ellipsis-blue?color=175173">](https://www.ellipsis.dev?ref=stack-auth%2Fstack-auth&utm_source=github&utm_medium=referral)<sup>
for f3b3d75a35. You can
[customize](https://app.ellipsis.dev/stack-auth/settings/summaries) this
summary. It will automatically update as commits are pushed.</sup>

<!-- ELLIPSIS_HIDDEN -->

---------

Co-authored-by: Konsti Wohlwend <n2d4xc@gmail.com>
2025-07-15 11:13:32 -05:00
..
lib Add API docs to llms.txt file. (#766) 2025-07-15 11:13:32 -05:00
public Re-add CLI auth docs 2025-07-03 15:43:36 -07:00
scripts Docs updates (#753) 2025-07-11 10:00:02 -07:00
src [Docs] posthog Integration (#761) 2025-07-14 13:49:36 -05:00
templates Docs updates (#753) 2025-07-11 10:00:02 -07:00
templates-api New docs (#698) 2025-06-20 13:30:01 -07:00
templates-python Docs updates (#753) 2025-07-11 10:00:02 -07:00
.env.development New docs (#698) 2025-06-20 13:30:01 -07:00
.eslintrc.json New docs (#698) 2025-06-20 13:30:01 -07:00
.gitignore Docs updates (#753) 2025-07-11 10:00:02 -07:00
CHANGELOG.md chore: update package versions 2025-07-13 09:06:47 -07:00
cli.json New docs (#698) 2025-06-20 13:30:01 -07:00
docs-platform.yml Docs updates (#753) 2025-07-11 10:00:02 -07:00
middleware.ts Docs updates (#753) 2025-07-11 10:00:02 -07:00
next.config.mjs Add API docs to llms.txt file. (#766) 2025-07-15 11:13:32 -05:00
package.json [Docs] posthog Integration (#761) 2025-07-14 13:49:36 -05:00
postcss.config.mjs New docs (#698) 2025-06-20 13:30:01 -07:00
README.md New docs (#698) 2025-06-20 13:30:01 -07:00
source.config.ts New docs (#698) 2025-06-20 13:30:01 -07:00
tsconfig.json New docs (#698) 2025-06-20 13:30:01 -07:00

README.md

stack-docs

This is a Next.js application generated with Create Fumadocs.

Run development server:

npm run dev
# or
pnpm dev
# or
yarn dev

Open http://localhost:3000 with your browser to see the result.

Explore

In the project, you can see:

  • lib/source.ts: Code for content source adapter, loader() provides the interface to access your content.
  • app/layout.config.tsx: Shared options for layouts, optional but preferred to keep.
Route Description
app/(home) The route group for your landing page and other pages.
app/docs The documentation layout and pages.
app/api The documentation for API pages.
app/api/search/route.ts The Route Handler for search.

Fumadocs MDX

A source.config.ts config file has been included, you can customise different options like frontmatter schema.

Read the Introduction for further details.

Learn More

To learn more about Next.js and Fumadocs, take a look at the following resources: