Skip to content

NIAD-3440: Updating documentation links#374

Closed
chiaramapellimt wants to merge 5 commits into
developfrom
NIAD-3440
Closed

NIAD-3440: Updating documentation links#374
chiaramapellimt wants to merge 5 commits into
developfrom
NIAD-3440

Conversation

@chiaramapellimt

@chiaramapellimt chiaramapellimt commented Mar 31, 2026

Copy link
Copy Markdown
Contributor

What

We need to change the links to documentation.

Why

Because they moved the docs from new locations, so they were broken.

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Internal change (non-breaking change with no effect on the functionality affecting end users)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist:

  • I have performed a self-review of my code
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I have updated the Changelog with details of my change in the UNRELEASED section if this change will affect end users

@github-actions

github-actions Bot commented Mar 31, 2026

Copy link
Copy Markdown

Images built and published to ECR using a Build Id of PR-296-198859f

@chiaramapellimt chiaramapellimt marked this pull request as ready for review March 31, 2026 13:09
@chiaramapellimt chiaramapellimt requested a review from a team as a code owner March 31, 2026 13:09
values sent to the adaptor must comply with the GP Links Specification and FHSREG:0:1:FH:FHS001.

https://digital.nhs.uk/services/nhais/guide-to-nhais-gp-links-documentation
https://digital.nhs.uk/developer/api-catalogue/nhais-gp-links/guide-to-nhais-gp-links-documentation

@Jonopono123 Jonopono123 Mar 31, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Would it be worth changing these to actual links as below? It should preserve them as clickable links regardless of the preview tool used.

Suggested change
https://digital.nhs.uk/developer/api-catalogue/nhais-gp-links/guide-to-nhais-gp-links-documentation
[Guide to NHAIS GP links](https://digital.nhs.uk/developer/api-catalogue/nhais-gp-links/guide-to-nhais-gp-links-documentation)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This won't work in the description block of an OpenAPI API call block. It will just ignore the markdown tags and show the link directly:

Image

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Screenshot 2026-03-31 at 15 50 54 Looks like it works fine on mine, have you tried refreshing the preview?

values sent to the adaptor must comply with the GP Links Specification and FHSREG:0:1:FH:FHS001.

https://digital.nhs.uk/services/nhais/guide-to-nhais-gp-links-documentation
https://digital.nhs.uk/developer/api-catalogue/nhais-gp-links/guide-to-nhais-gp-links-documentation

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
https://digital.nhs.uk/developer/api-catalogue/nhais-gp-links/guide-to-nhais-gp-links-documentation
[Guide to NHAIS GP links](https://digital.nhs.uk/developer/api-catalogue/nhais-gp-links/guide-to-nhais-gp-links-documentation)

values sent to the adaptor must comply with the GP Links Specification and FHSREG:0:1:FH:FHS001.

https://digital.nhs.uk/services/nhais/guide-to-nhais-gp-links-documentation
https://digital.nhs.uk/developer/api-catalogue/nhais-gp-links/guide-to-nhais-gp-links-documentation

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
https://digital.nhs.uk/developer/api-catalogue/nhais-gp-links/guide-to-nhais-gp-links-documentation
[Guide to NHAIS GP links](https://digital.nhs.uk/developer/api-catalogue/nhais-gp-links/guide-to-nhais-gp-links-documentation)

@MartinWheelerMT MartinWheelerMT left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Hangfire on this PR, until I've worked out the implications of changing the system identifer:

"https://digital.nhs.uk/services/nhais/guide-to-nhais-gp-links-documentation"

values sent to the adaptor must comply with the GP Links Specification and FHSREG:0:1:FH:FHS001.

https://digital.nhs.uk/services/nhais/guide-to-nhais-gp-links-documentation
https://digital.nhs.uk/developer/api-catalogue/nhais-gp-links/guide-to-nhais-gp-links-documentation

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
https://digital.nhs.uk/developer/api-catalogue/nhais-gp-links/guide-to-nhais-gp-links-documentation
[Guide to NHAIS GP links](https://digital.nhs.uk/developer/api-catalogue/nhais-gp-links/guide-to-nhais-gp-links-documentation)

@chiaramapellimt

Copy link
Copy Markdown
Contributor Author

Hangfire on this PR, until I've worked out the implications of changing the system identifer:

"https://digital.nhs.uk/services/nhais/guide-to-nhais-gp-links-documentation"

Yep

@chiaramapellimt chiaramapellimt deleted the NIAD-3440 branch April 1, 2026 08:03
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