Skip to content

add llms.txt file for easier use with llms#157

Open
schwzr wants to merge 3 commits intomainfrom
156-add-llmstxt-file-for-easier-use-with-llms
Open

add llms.txt file for easier use with llms#157
schwzr wants to merge 3 commits intomainfrom
156-add-llmstxt-file-for-easier-use-with-llms

Conversation

@schwzr
Copy link
Copy Markdown
Member

@schwzr schwzr commented Mar 31, 2026

  • Remove hardcoded "Latest version: DSF 2.0.2" from the intro description
  • Remove hardcoded version from the Operations section header (was "v2.0.2 - Latest", now "Latest")
  • Update Installation Guide and Release Notes descriptions to not reference a specific version

schwzr and others added 2 commits March 31, 2026 20:12
Provides a structured index of all DSF documentation pages following
the llms.txt standard (https://llmstxt.org), making the site easier
to consume for AI tools and large language models.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Contains the full text of all current documentation pages (v2.0.2)
stripped of frontmatter, for LLMs that prefer ingesting complete
content at once. Companion to llms.txt which provides the index.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR adds an llms.txt entrypoint to the VuePress public assets to provide an LLM-friendly, curated index into the DSF documentation and key resources (concepts, operations, troubleshooting, and process plugin development).

Changes:

  • Add a new docs/src/.vuepress/public/llms.txt file containing a structured overview and deep links into DSF docs.
  • Organize links by major areas (Core Concepts, Use Cases, Operations, Troubleshooting, Development, Community).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@@ -0,0 +1,137 @@
# Data Sharing Framework (DSF)

> The Data Sharing Framework (DSF) is a secure middleware for distributing data sharing processes based on BPMN 2.0 and FHIR R4 standards. It enables biomedical researchers to extract, merge, pseudonymize, and share data across organizational boundaries. Funded by the German Federal Ministry of Research, Technology and Space within the Medical Informatics Initiative (MII). Latest version: DSF 2.0.2. Website: https://dsf.dev
Copy link

Copilot AI Mar 31, 2026

Choose a reason for hiding this comment

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

This sentence hardcodes a specific “Latest version: DSF 2.0.2”. Since this file is meant as a stable entrypoint for LLMs, consider avoiding embedding a patch version in a “latest” claim (or ensure it’s updated as part of every release) to prevent it from becoming stale/misleading.

Copilot uses AI. Check for mistakes.
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

@copilot apply changes based on this feedback

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Removed "Latest version: DSF 2.0.2" from the intro paragraph in commit 95b41c1. The description no longer embeds a specific version number.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Done in commit 908df3a. Removed the hardcoded DSF 2.0.2 version from the intro description, the Operations section header (now "Latest"), and the Installation Guide / Release Notes bullet descriptions (now refer to "the latest DSF release").

Comment on lines +21 to +25
## Operations (v2.0.2 - Latest)

- [Get Started](https://dsf.dev/operations/get-started.html): Getting started with DSF operations
- [Installation Guide](https://dsf.dev/operations/latest/install.html): Step-by-step installation of DSF v2.0.2
- [Release Notes](https://dsf.dev/operations/latest/release-notes.html): What's new in DSF v2.0.2
Copy link

Copilot AI Mar 31, 2026

Choose a reason for hiding this comment

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

The section header and bullets include “v2.0.2 - Latest” / “DSF v2.0.2”. If the intent is to always point to the current release, consider removing the hardcoded version from these “latest” headings/descriptions and rely on the /operations/latest links (or make updating this file an explicit part of the release workflow).

Copilot uses AI. Check for mistakes.
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

@copilot apply changes based on this feedback

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Removed the hardcoded version from the Operations section header (v2.0.2 - LatestLatest) and updated the Installation Guide and Release Notes descriptions to be version-agnostic in commit 95b41c1.

Use version-agnostic descriptions and rely on /operations/latest
links instead, so the files don't become stale on new releases.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@schwzr schwzr requested a review from seay28 March 31, 2026 18:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants