oppia / oppia/oppia-web-developer-docs

Add CI to wiki repo (check mediawiki links, check other links, check toc)

Open
#21 10 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement good first issue Impact: Medium Work: Medium
Dominant language
Python
Stars
18
Forks
133
PR merge metrics
No merged PRs in 30d

Description

CI checks for wiki repo:

  • MediaWiki links are valid and point to a real page
  • Other links are valid
  • TOC matches headers
  • Markdown Syntax. (Example) (Example 2)

Contributor guide

No contributing guide indexed for this repository

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

Start in the oppia-web-developer-docs repository by reviewing the wiki's Markdown files and the two linked marketplace examples. Determine how CI should validate MediaWiki links, other links, the table of contents, and Markdown syntax. Done means the repository's checks cover all four checklist items and report invalid content clearly.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
ci-cd, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
32/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.