Skip to content

DOCS: add LLM-friendly files, backend compatibility page, and new-user README path#1970

Closed
svandenb-dev wants to merge 9 commits intomainfrom
llm-friendly-files
Closed

DOCS: add LLM-friendly files, backend compatibility page, and new-user README path#1970
svandenb-dev wants to merge 9 commits intomainfrom
llm-friendly-files

Conversation

@svandenb-dev
Copy link
Copy Markdown
Collaborator

@svandenb-dev svandenb-dev commented Mar 27, 2026

This PR keeps the scope coherent:

  • better onboarding for humans,
  • clearer backend messaging,
  • and better AI retrieval/discoverability. PyEDB already has the public docs/release/package surfaces needed for this to work well; this PR mainly improves how the project presents its canonical entry points.

closes #1971

@svandenb-dev svandenb-dev self-assigned this Mar 27, 2026
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Mar 27, 2026
@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Mar 27, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 48.87%. Comparing base (5cbae21) to head (b1fb93e).
⚠️ Report is 61 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff             @@
##             main    #1970       +/-   ##
===========================================
- Coverage   70.20%   48.87%   -21.34%     
===========================================
  Files         261      263        +2     
  Lines       42416    43009      +593     
===========================================
- Hits        29779    21019     -8760     
- Misses      12637    21990     +9353     
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@svandenb-dev svandenb-dev enabled auto-merge (squash) March 27, 2026 12:21
Copy link
Copy Markdown
Collaborator

@SMoraisAnsys SMoraisAnsys left a comment

Choose a reason for hiding this comment

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

Adding request changes to avoid merging before discussions on this topic occurs. Should be performed next week if possible

@codacy-production
Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

TIP This summary will be updated as you push new changes. Give us feedback

Copy link
Copy Markdown
Collaborator

@eblanco-ansys eblanco-ansys left a comment

Choose a reason for hiding this comment

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

As discussed, IMO it would make more sense to put those files in doc/source directly, to let the crawlers access them more easily

Copy link
Copy Markdown
Collaborator

@SMoraisAnsys SMoraisAnsys left a comment

Choose a reason for hiding this comment

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

If the goal is that those file get used afterward (by crawlers for example), shouldn't we try another approach ? I'm not sure if there is a standard to this or not (AI related)

@svandenb-dev
Copy link
Copy Markdown
Collaborator Author

If the goal is that those file get used afterward (by crawlers for example), shouldn't we try another approach ? I'm not sure if there is a standard to this or not (AI related)

If the goal is that those file get used afterward (by crawlers for example), shouldn't we try another approach ? I'm not sure if there is a standard to this or not (AI related)

If the goal is that those file get used afterward (by crawlers for example), shouldn't we try another approach ? I'm not sure if there is a standard to this or not (AI related)

It is a standard but we an discuss later.

@svandenb-dev svandenb-dev marked this pull request as draft April 2, 2026 14:24
auto-merge was automatically disabled April 2, 2026 14:24

Pull request was converted to draft

@eblanco-ansys
Copy link
Copy Markdown
Collaborator

If the goal is that those file get used afterward (by crawlers for example), shouldn't we try another approach ? I'm not sure if there is a standard to this or not (AI related)

I did some research yesterday and generally this llms.txt file is stored at the root of the documentation webpage

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

DOCS improve documention for LLM bots scrawlers.

6 participants