QuantConnect / QuantConnect/Documentation

Fix broken documentation links

Open Beginner friendly
#2,682 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
HTML
Stars
261
Forks
191
Avg merge
16h 28m
Merged PRs (30d)
56

Description

Broken Documentation Links

The URL checker found broken links that need to be fixed.

missing_section (4)
  • No Section "11 Get Deployment Id" was found: https://www.quantconnect.com/docs/v2/local-platform/live-trading/getting-started#11-Get-Deployment-Id
    • /home/runner/work/Documentation/Documentation/04 Research Environment/10 Meta Analysis/04 Live Analysis/02 Read Live Results.php
  • No Section "16 Custom Memories" was found: https://www.quantconnect.com/docs/v2/ai-assistance/agents#16-Custom-Memories
    • /home/runner/work/Documentation/Documentation/09 AI Assistance/02 Agents/02 Why Use Agent Harness.html
  • No Section "15 Custom Skills" was found: https://www.quantconnect.com/docs/v2/ai-assistance/agents#15-Custom-Skills
    • /home/runner/work/Documentation/Documentation/09 AI Assistance/02 Agents/02 Why Use Agent Harness.html
  • No Section "02 Cross Platform Discrepancies" was found: https://www.quantconnect.com/docs/v2/cloud-platform/datasets/misconceptions#02-Cross-Platform-Discrepancies
    • /home/runner/work/Documentation/Documentation/01 Cloud Platform/09 Datasets/03 Data Issues/02 Common Issues.html
    • /home/runner/work/Documentation/Documentation/01 Cloud Platform/09 Datasets/03 Data Issues/05 Best Practices.html

After fixing the links, run python url_check.py locally to confirm all broken links are resolved before closing this issue.

Auto-generated by url_check.py

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Update the links in 04 Research Environment/10 Meta Analysis/04 Live Analysis/02 Read Live Results.php, 09 AI Assistance/02 Agents/02 Why Use Agent Harness.html, and the two files under 01 Cloud Platform/09 Datasets/03 Data Issues. Start by checking the corresponding documentation headings, then run python url_check.py locally; done means all four missing-section link errors are resolved.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
88/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.