Skip to content

mkdocs.yml: Fix broken links in documentation#5733

Open
rene wants to merge 1 commit intolf-edge:masterfrom
rene:fix-broken-links
Open

mkdocs.yml: Fix broken links in documentation#5733
rene wants to merge 1 commit intolf-edge:masterfrom
rene:fix-broken-links

Conversation

@rene
Copy link
Copy Markdown
Contributor

@rene rene commented Apr 2, 2026

Description

  • Remove API links since API code has been moved to a dedicated project since EVE 10.6.0
  • Fix link for go-libzfs
  • Fix a typo

How to test and validate this PR

Just check the generated documentation in https://eve-os.readthedocs.io/

Changelog notes

None.

PR Backports

No need to backport.

Checklist

  • I've provided a proper description
  • I've added the proper documentation
  • I've tested my PR on amd64 device
  • I've tested my PR on arm64 device
  • I've written the test verification instructions
  • I've set the proper labels to this PR
  • I've checked the boxes above, or I've provided a good reason why I didn't
    check them.

- Remove API links since API code has been moved to a dedicated project
  since EVE 10.6.0
- Fix link for go-libzfs
- Fix a typo

Signed-off-by: Renê de Souza Pinto <rene@renesp.com.br>
@rene rene requested a review from eriknordmark as a code owner April 2, 2026 09:16
@codecov
Copy link
Copy Markdown

codecov bot commented Apr 2, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 29.87%. Comparing base (2281599) to head (16087a9).
⚠️ Report is 441 commits behind head on master.

Additional details and impacted files
@@             Coverage Diff             @@
##           master    #5733       +/-   ##
===========================================
+ Coverage   19.52%   29.87%   +10.34%     
===========================================
  Files          19       18        -1     
  Lines        3021     2417      -604     
===========================================
+ Hits          590      722      +132     
+ Misses       2310     1549      -761     
- Partials      121      146       +25     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

- Debugging: 'docs/DEBUGGING.md'
- 'Kernel dump collection': 'docs/KERNEL-DUMPS.md'
- API:
- Information: 'api/README.md'
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Maybe pint to github.com/lf-edge/eve-api repo ?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I don't think is needed, we have specific links to eve-api throughout the documentation.....

Copy link
Copy Markdown
Contributor

@eriknordmark eriknordmark left a comment

Choose a reason for hiding this comment

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

LGTM

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