monzo / monzo/docs

Account Information Services API links incorrect

Open
#171 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
SCSS
Stars
116
Forks
51
Avg merge
1h 25m
Merged PRs (30d)
1

Description

On https://docs.monzo.com/ the "Account Information Services API" section ( https://docs.monzo.com/#account-information-services-api ) lists a number of subsections - each individually linked from the menu. However, since some sections have the same name as the "Monzo Native API" sections (such as "Authentication", "Accounts", "Balances", "Pots", "Direct Debits" etc), the side menu does NOT highlight as you scroll down and if you click on the appropriate item in the side menu, you are taken to the "Monzo Native API" section.

The internal hyperlinks for the Account Information Services API really need to have prefixes appended to them and the relevant "id" fields.

qv: https://community.monzo.com/t/documentation-bug-account-information-services-api-links-incorrect/152141

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

Start at the Account Information Services API section on docs.monzo.com and inspect the side-menu links, subsection anchors, and corresponding id fields. Done means each link targets the Account Information Services API subsection rather than the similarly named Monzo Native API section, and the correct menu item highlights while scrolling.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.