Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions apps/docs/e2e/Navigation.cy.res
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,21 @@ let waitForHydration = () => {
// re-query from the DOM root on each retry.

let clickNavLink = (~testId, ~text) => {
get(`[data-testid="${testId}"] a:visible`)
->containsChainable(text)
getByTestId(testId)
->should("be.visible")
->containsSelectorChainable("a", text)
->scrollIntoView
->should("be.visible")
->click
->ignore
}

let clickMobileNavLink = text => {
get(`[data-testid="mobile-nav"] a:visible`)
->containsChainable(text)
getByTestId("mobile-nav")
->should("be.visible")
->containsSelectorChainable("a", text)
->scrollIntoView
->should("be.visible")
->click
->ignore
}
Expand Down
25 changes: 8 additions & 17 deletions apps/docs/markdown-pages/docs/manual/llms.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ order: 4

We adhere to the [llms.txt convention](https://llmstxt.org/) to make documentation accessible to large language models and their applications.

This ReScript manual major version: `v12 (current version)`.
## Files

The root `/llms.txt` file is the default entry point and always describes the current stable manual. Use the files under `/llms/manual/v13/` (pre-release version) or `/llms/manual/v12/` (current version) when you want an explicit major-version path. These major-version paths use the latest generated documentation for that major version and avoid full patch numbers in the URL.

## Default Current Files

- [/llms.txt](/llms.txt) - a list of the available files for the current ReScript language manual.
- [/llms/manual/llm-full.txt](/llms/manual/llm-full.txt) - complete current documentation for the ReScript language.
- [/llms/manual/llm-small.txt](/llms/manual/llm-small.txt) - abridged current documentation without detailed examples.
- [/llms.txt](/llms.txt) - a list of the available files for the ReScript language manual.
- [/llms/manual/llm-full.txt](/llms/manual/llm-full.txt) - complete documentation for the ReScript language.
- [/llms/manual/llm-small.txt](/llms/manual/llm-small.txt) - abridged documentation without detailed examples.
- [/llms/manual/language-overview/llm.txt](/llms/manual/language-overview/llm.txt) - focused documentation for ReScript syntax and core language features.
- [/llms/manual/javascript-interop/llm.txt](/llms/manual/javascript-interop/llm.txt) - focused documentation for binding to JavaScript and TypeScript code.
- [/llms/manual/build-system/llm.txt](/llms/manual/build-system/llm.txt) - focused documentation for build configuration, project structure, and build-tool integration.
- [/llms/manual/getting-started/llm.txt](/llms/manual/getting-started/llm.txt) - focused documentation for installation, editor setup, migrations, and JavaScript onboarding.

## Package Documentation

Expand All @@ -27,12 +27,3 @@ The root `/llms.txt` file is the default entry point and always describes the cu
## Notes

- The content is automatically generated from the same source as the official documentation for the specific version.

## Major Version Files

- [v13 pre-release LLMs index](/llms/manual/v13/llms.txt) - a list of the available files for the latest ReScript v13 pre-release documentation.
- [v13 pre-release complete documentation](/llms/manual/v13/llm-full.txt) - complete latest ReScript v13 pre-release documentation.
- [v13 pre-release abridged documentation](/llms/manual/v13/llm-small.txt) - abridged latest ReScript v13 pre-release documentation.
- [v12 current LLMs index](/llms/manual/v12/llms.txt) - a list of the available files for the current ReScript v12 documentation.
- [v12 current complete documentation](/llms/manual/v12/llm-full.txt) - complete current ReScript v12 documentation.
- [v12 current abridged documentation](/llms/manual/v12/llm-small.txt) - abridged current ReScript v12 documentation.
20 changes: 4 additions & 16 deletions apps/docs/markdown-pages/docs/react/llms.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,23 +9,11 @@ section: "Overview"

We adhere to the [llms.txt convention](https://llmstxt.org/) to make documentation accessible to large language models and their applications.

Current ReScript React documentation version: `v0.14.2`.
ReScript React package version: `v0.14.2`.
React version: `v19.2.4`.
## Files

The unversioned files under `/llms/react/` are the default entry points and always describe the current ReScript React docs. Use the versioned files under `/llms/react/v0.14.2/` when you want a stable path for this ReScript React documentation version.

## Default Current Files

- [/llms/react/llms.txt](/llms/react/llms.txt) - a list of the available files for the current ReScript React docs.
- [/llms/react/llm-full.txt](/llms/react/llm-full.txt) - complete current documentation for ReScript React.
- [/llms/react/llm-small.txt](/llms/react/llm-small.txt) - abridged current documentation without detailed examples.

## Versioned Files

- [/llms/react/v0.14.2/llms.txt](/llms/react/v0.14.2/llms.txt) - a list of the available files for ReScript React `v0.14.2`.
- [/llms/react/v0.14.2/llm-full.txt](/llms/react/v0.14.2/llm-full.txt) - complete documentation for ReScript React `v0.14.2`.
- [/llms/react/v0.14.2/llm-small.txt](/llms/react/v0.14.2/llm-small.txt) - abridged documentation for ReScript React `v0.14.2`.
- [/llms/react/llms.txt](/llms/react/llms.txt) - a list of the available files for ReScript React docs.
- [/llms/react/llm-full.txt](/llms/react/llm-full.txt) - complete documentation for ReScript React.
- [/llms/react/llm-small.txt](/llms/react/llm-small.txt) - abridged documentation without detailed examples.

## Language Documentation

Expand Down
25 changes: 8 additions & 17 deletions apps/docs/public/llms/manual/template.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ order: 4

We adhere to the [llms.txt convention](https://llmstxt.org/) to make documentation accessible to large language models and their applications.

This ReScript manual major version: `<MANUAL_VERSION_LABEL>`.
## Files

The root `/llms.txt` file is the default entry point and always describes the current stable manual. Use the files under `/llms/manual/v13/` (pre-release version) or `/llms/manual/v12/` (current version) when you want an explicit major-version path. These major-version paths use the latest generated documentation for that major version and avoid full patch numbers in the URL.

## Default Current Files

- [/llms.txt](/llms.txt) - a list of the available files for the current ReScript language manual.
- [/llms/manual/llm-full.txt](/llms/manual/llm-full.txt) - complete current documentation for the ReScript language.
- [/llms/manual/llm-small.txt](/llms/manual/llm-small.txt) - abridged current documentation without detailed examples.
- [/llms.txt](/llms.txt) - a list of the available files for the ReScript language manual.
- [/llms/manual/llm-full.txt](/llms/manual/llm-full.txt) - complete documentation for the ReScript language.
- [/llms/manual/llm-small.txt](/llms/manual/llm-small.txt) - abridged documentation without detailed examples.
- [/llms/manual/language-overview/llm.txt](/llms/manual/language-overview/llm.txt) - focused documentation for ReScript syntax and core language features.
- [/llms/manual/javascript-interop/llm.txt](/llms/manual/javascript-interop/llm.txt) - focused documentation for binding to JavaScript and TypeScript code.
- [/llms/manual/build-system/llm.txt](/llms/manual/build-system/llm.txt) - focused documentation for build configuration, project structure, and build-tool integration.
- [/llms/manual/getting-started/llm.txt](/llms/manual/getting-started/llm.txt) - focused documentation for installation, editor setup, migrations, and JavaScript onboarding.

## Package Documentation

Expand All @@ -27,12 +27,3 @@ The root `/llms.txt` file is the default entry point and always describes the cu
## Notes

- The content is automatically generated from the same source as the official documentation for the specific version.

## Major Version Files

- [v13 pre-release LLMs index](/llms/manual/v13/llms.txt) - a list of the available files for the latest ReScript v13 pre-release documentation.
- [v13 pre-release complete documentation](/llms/manual/v13/llm-full.txt) - complete latest ReScript v13 pre-release documentation.
- [v13 pre-release abridged documentation](/llms/manual/v13/llm-small.txt) - abridged latest ReScript v13 pre-release documentation.
- [v12 current LLMs index](/llms/manual/v12/llms.txt) - a list of the available files for the current ReScript v12 documentation.
- [v12 current complete documentation](/llms/manual/v12/llm-full.txt) - complete current ReScript v12 documentation.
- [v12 current abridged documentation](/llms/manual/v12/llm-small.txt) - abridged current ReScript v12 documentation.
22 changes: 8 additions & 14 deletions apps/docs/public/llms/manual/template.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,17 @@

> ReScript is a robustly typed language that compiles to efficient and human-readable JavaScript. It comes with a lightning fast compiler toolchain that scales to any codebase size.

## Documentation Sets

This ReScript manual major version: <MANUAL_VERSION_LABEL>.

The root `/llms.txt` file is the default entry point and always describes the current stable manual. Use the files under `/llms/manual/v13/` (pre-release version) or `/llms/manual/v12/` (current version) when you want an explicit major-version path. These major-version paths use the latest generated documentation for that major version and avoid full patch numbers in the URL.

### Default Current Files
## Files

- [LLMs index](https://rescript-lang.org/llms.txt): This file
- [Complete current documentation](https://rescript-lang.org/llms/manual/llm-full.txt): The complete current ReScript documentation including all examples and additional content
- [Abridged current documentation](https://rescript-lang.org/llms/manual/llm-small.txt): A minimal current version of the ReScript documentation, with the essential content for quick reference
- [Complete documentation](https://rescript-lang.org/llms/manual/llm-full.txt): The complete ReScript documentation including all examples and additional content
- [Abridged documentation](https://rescript-lang.org/llms/manual/llm-small.txt): A minimal ReScript documentation file with the essential content for quick reference
Comment on lines +8 to +9
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge Restore version-scoped links in manual versioned llms.txt

The manual text template now hardcodes unversioned URLs (/llms/manual/llm-*.txt), and copyCurrentFilesToVersion reuses this same template for /llms/manual/v12/llms.txt and /llms/manual/v13/llms.txt. That means a client entering through a versioned index will be directed back to the moving “current” files instead of the pinned version files, so once current advances (e.g. to v13), /llms/manual/v12/llms.txt no longer resolves to v12 content.

Useful? React with 👍 / 👎.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should probably just drop the files for specific versions to keep things simple.

Comment thread
jderochervlk marked this conversation as resolved.
- [Language overview](https://rescript-lang.org/llms/manual/language-overview/llm.txt): Focused documentation for ReScript syntax and core language features
- [JavaScript interop](https://rescript-lang.org/llms/manual/javascript-interop/llm.txt): Focused documentation for binding to JavaScript and TypeScript code
- [Build system](https://rescript-lang.org/llms/manual/build-system/llm.txt): Focused documentation for build configuration, project structure, and build-tool integration
- [Getting started](https://rescript-lang.org/llms/manual/getting-started/llm.txt): Focused documentation for installation, editor setup, migrations, and JavaScript onboarding

## Individual Package Documentation
## Package Documentation

- [ReScript React documentation](https://rescript-lang.org/llms/react/llms.txt): This is the developer documentation for ReScript React.

Expand All @@ -24,7 +22,3 @@ The root `/llms.txt` file is the default entry point and always describes the cu
- The complete documentation includes all content from the official documentation
- Package-specific documentation files contain only the content relevant to that package
- The content is automatically generated from the same source as the official documentation for the specific version

### Major Version Files

<MANUAL_VERSION_LINKS>
20 changes: 4 additions & 16 deletions apps/docs/public/llms/react/template.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,23 +9,11 @@ section: "Overview"

We adhere to the [llms.txt convention](https://llmstxt.org/) to make documentation accessible to large language models and their applications.

Current ReScript React documentation version: `<VERSION>`.
ReScript React package version: `<RESCRIPT_REACT_VERSION>`.
React version: `<REACT_VERSION>`.
## Files

The unversioned files under `/llms/react/` are the default entry points and always describe the current ReScript React docs. Use the versioned files under `/llms/react/<VERSION>/` when you want a stable path for this ReScript React documentation version.

## Default Current Files

- [/llms/react/llms.txt](/llms/react/llms.txt) - a list of the available files for the current ReScript React docs.
- [/llms/react/llm-full.txt](/llms/react/llm-full.txt) - complete current documentation for ReScript React.
- [/llms/react/llm-small.txt](/llms/react/llm-small.txt) - abridged current documentation without detailed examples.

## Versioned Files

- [/llms/react/<VERSION>/llms.txt](/llms/react/<VERSION>/llms.txt) - a list of the available files for ReScript React `<VERSION>`.
- [/llms/react/<VERSION>/llm-full.txt](/llms/react/<VERSION>/llm-full.txt) - complete documentation for ReScript React `<VERSION>`.
- [/llms/react/<VERSION>/llm-small.txt](/llms/react/<VERSION>/llm-small.txt) - abridged documentation for ReScript React `<VERSION>`.
- [/llms/react/llms.txt](/llms/react/llms.txt) - a list of the available files for ReScript React docs.
- [/llms/react/llm-full.txt](/llms/react/llm-full.txt) - complete documentation for ReScript React.
- [/llms/react/llm-small.txt](/llms/react/llm-small.txt) - abridged documentation without detailed examples.

## Language Documentation

Expand Down
20 changes: 3 additions & 17 deletions apps/docs/public/llms/react/template.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,11 @@

> ReScript React is a strongly typed interface for React, designed to integrate seamlessly with modern React (>= v18.0) while compiling to idiomatic JavaScript, enabling robust and scalable React applications.

## ReScript React Documentation

Current ReScript React documentation version: <VERSION>.
ReScript React package version: <RESCRIPT_REACT_VERSION>.
React version: <REACT_VERSION>.

The unversioned files under `/llms/react/` are the default entry points and always describe the current ReScript React docs. Use the versioned files under `/llms/react/<VERSION>/` when you want a stable path for this ReScript React documentation version.

### Default Current Files
## Files

- [LLMs index](https://rescript-lang.org/llms/react/llms.txt): This file
- [Complete current documentation](https://rescript-lang.org/llms/react/llm-full.txt): The complete current ReScript React documentation including all examples and additional content
- [Abridged current documentation](https://rescript-lang.org/llms/react/llm-small.txt): A minimal current version of the ReScript React documentation, with the essential content for quick reference

### Versioned Files

- [<VERSION> LLMs index](https://rescript-lang.org/llms/react/<VERSION>/llms.txt): This file for ReScript React <VERSION>
- [<VERSION> complete documentation](https://rescript-lang.org/llms/react/<VERSION>/llm-full.txt): The complete ReScript React <VERSION> documentation including all examples and additional content
- [<VERSION> abridged documentation](https://rescript-lang.org/llms/react/<VERSION>/llm-small.txt): A minimal ReScript React <VERSION> reference with the essential content
- [Complete documentation](https://rescript-lang.org/llms/react/llm-full.txt): The complete ReScript React documentation including all examples and additional content
- [Abridged documentation](https://rescript-lang.org/llms/react/llm-small.txt): A minimal ReScript React documentation file with the essential content for quick reference
Comment thread
jderochervlk marked this conversation as resolved.
Comment thread
jderochervlk marked this conversation as resolved.

## Language Documentation

Expand Down
Loading
Loading