🐛📝 Fixes and tests links on the doc (#188)

Author: pcrespov

clients/python/test/tests_docs.py

@@ -0,0 +1,40 @@
+import pytest
+import sys
+import re
+from pathlib import Path
+
+_CURRENT_DIR = (
+    Path(sys.argv[0] if __name__ == "__main__" else __file__).resolve().parent
+)
+_REPO_DIR = _CURRENT_DIR.parent.parent.parent
+_DOCS_DIR = _REPO_DIR / "docs"
+
+assert _DOCS_DIR.exists
+
+_MD_LINK_PATTERN = re.compile(r"\[(.*?)\]\((.*?)\)")
+
+
+def _collect_links():
+    def _extract_file_links(markdown_file: Path) -> tuple[Path, str, str]:
+        content = markdown_file.read_text()
+        # Find all markdown links (e.g., [text](path/to/file))
+        links = _MD_LINK_PATTERN.findall(content)
+        return [(markdown_file, text, file_link) for text, file_link in links]
+
+    links = []
+    for md_file in _DOCS_DIR.rglob("*.md"):
+        links.extend(_extract_file_links(md_file))
+    return links
+
+
+@pytest.mark.parametrize("md_file, link_text, file_link", _collect_links())
+def test_markdown_links(md_file: Path, link_text: str, file_link: str):
+    if file_link.startswith("http"):
+        pytest.skip(f"External link skipped: {file_link}")
+
+    # NOTE: that current doc only support relative to repo!
+    relative_to_repo = (_REPO_DIR / file_link).resolve()
+
+    assert (
+        relative_to_repo.exists()
+    ), f"Broken link found: [{link_text}]({file_link}) in {md_file}"

docs/doc_entrypoint.md

@@ -24,11 +24,10 @@ pip install osparc
 
 ## Getting Started with `osparc`
 
-To begin using `osparc`, simply import the package and refer to the detailed examples provided in the [official documentation](https://github.com/your-username/osparc/wiki).
 
 ### API Key/Secret Setup
 
-Before interacting with the osparc API, you need to generate an API key-secret pair from your osparc account. Follow the [instructions here](https://docs.osparc.io/#/docs/platform_introduction/profile?id=preferences) to create the key and secret.
+Before interacting with the osparc API, you need to generate an API key-secret pair from your osparc account. Follow the [instructions here](https://docs.osparc.io/#/docs/platform_introduction/user_setup/security_details?id=generating-o%c2%b2s%c2%b2parc-tokens) to create the key and secret.
 
 Once generated, you can configure them by either:
 
@@ -79,13 +78,9 @@ For more in-depth usage, refer to the following tutorial guides:
 - [Version 0.6 Documentation](clients/python/docs/v0.6.0/README.md)
 
 
-## Contributing
-
-We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details on how to get involved.
-
 ## License
 
-This project is licensed under the MIT License. See the [LICENSE](../LICENSE) file for details.
+This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.
 
 ---