Skip to content

Conversation

@leeyi45
Copy link
Contributor

@leeyi45 leeyi45 commented Nov 7, 2025

Quick and dirty PR for fixing the developer documentation . @RichDom2185 if there is nothing else I'd like to merge this ahead of other fixes, otherwise the documentation for the repository is not accessible

README.md Outdated
| Default Modules Deployment | <https://source-academy.github.io/modules> |
| Default Modules Documentation | <https://source-academy.github.io/modules/documentation> |
| Developer Documentation | <https://source-academy.github.io/devdocs> |
| Developer Documentation | <https://source-academy.github.io/modules/devdocs |
Copy link

Choose a reason for hiding this comment

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

Bug: The markdown link in README.md at line 20 is missing a closing > character, malforming the URL.
Severity: HIGH | Confidence: 1.00

🔍 Detailed Analysis

The markdown table entry for 'Developer Documentation' in README.md at line 20 is missing the closing angle bracket > for the URL. This malforms the link https://source-academy.github.io/modules/devdocs causing markdown parsers to not recognize it as a valid clickable link. This results in incorrect rendering of the table cell and prevents the link from being clickable.

💡 Suggested Fix

Add the closing angle bracket > to the URL in the markdown table entry for 'Developer Documentation' in README.md at line 20. The corrected line should be | Developer Documentation | <https://source-academy.github.io/modules/devdocs> |.

🤖 Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent.
Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not
valid.

Location: README.md#L20

Potential issue: The markdown table entry for 'Developer Documentation' in `README.md`
at line 20 is missing the closing angle bracket `>` for the URL. This malforms the link
`https://source-academy.github.io/modules/devdocs` causing markdown parsers to not
recognize it as a valid clickable link. This results in incorrect rendering of the table
cell and prevents the link from being clickable.

Did we get this right? 👍 / 👎 to inform future reviews.

@leeyi45 leeyi45 enabled auto-merge (squash) November 7, 2025 23:13
@leeyi45 leeyi45 disabled auto-merge November 7, 2025 23:13
Copy link
Member

@RichDom2185 RichDom2185 left a comment

Choose a reason for hiding this comment

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

Okay for me, but CI is failing?

@RichDom2185 RichDom2185 merged commit 5ce950d into master Nov 8, 2025
11 of 12 checks passed
@RichDom2185 RichDom2185 deleted the documentation-fix branch November 8, 2025 06:20
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