Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix links between docs pages #697

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

dolfim-ibm
Copy link
Contributor

Fixing some broken links between docs pages (from mkdocs warnings).

Checklist:

  • Documentation has been updated, if necessary.
  • Examples have been added, if necessary.
  • Tests have been added, if necessary.

@dolfim-ibm dolfim-ibm requested a review from vagenas January 7, 2025 16:04
Copy link

mergify bot commented Jan 7, 2025

Merge Protections

Your pull request matches the following merge protections and will not be merged until they are valid.

🟢 Enforce conventional commit

Wonderful, this rule succeeded.

Make sure that we follow https://www.conventionalcommits.org/en/v1.0.0/

  • title ~= ^(fix|feat|docs|style|refactor|perf|test|build|ci|chore|revert)(?:\(.+\))?(!)?:

@vagenas
Copy link
Contributor

vagenas commented Jan 7, 2025

Based on https://ds4sd.github.io/docling/concepts/chunking/ both updated links appear to be working.
So maybe they are broken when navigating the raw .md files on GitHub, but if I recall correctly, setting them to the .md counterpart breaks the rendered docs.

@dolfim-ibm
Copy link
Contributor Author

Here are the mkdocs messages

INFO    -  Doc file 'v2.md' contains an unrecognized relative link '../examples/run_with_formats/', it was left as is.
INFO    -  Doc file 'v2.md' contains an unrecognized relative link '../examples/custom_convert/', it was left as is.
INFO    -  Doc file 'v2.md' contains an unrecognized relative link '../usage/#chunking', it was left as is. Did you mean 'usage.md#chunking'?
INFO    -  Doc file 'concepts/chunking.md' contains an unrecognized relative link '../../examples/hybrid_chunking', it was left as is.
INFO    -  Doc file 'concepts/chunking.md' contains an unrecognized relative link '../docling_document', it was left as is. Did you mean
           'docling_document.md'?

Copy link
Contributor

@vagenas vagenas left a comment

Choose a reason for hiding this comment

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

... but if I recall correctly, setting them to the .md counterpart breaks the rendered docs.

In the past I was experiencing issues like the ones described here, but now I checked and it works, so approving.

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.

2 participants