mathworks / mathworks/docmaker
Consider supporting matlab: in HTML anchor tags
Nobody has claimed this yet.
- Dominant language
- MATLAB
- Stars
- 9
- Forks
- 3
- Avg merge
- 13d 10h
- Merged PRs (30d)
- 2
Description
Use case is the Control 101 Toolbox (https://www.mathworks.com/matlabcentral/fileexchange/130439-control-101-toolbox). This uses matlab: in doc hyperlinks to copy Live Scripts from the installation folder of the toolbox to the user's working directory for editing. The authors have expressed interest in migrating the documentation away from handwritten HTML.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No file or test is named. Start by locating how docmaker handles HTML anchor tags, then reproduce the Control 101 Toolbox use case with a matlab: hyperlink. Done means generated documentation preserves and supports these links for the described Live Script workflow.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- matlab
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100