mi6 / mi6/ic-design-system

Remove 'contribute' URL on Guidance site pages

Open
#776 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

contribution model
Dominant language
MDX
Stars
79
Forks
52
Avg merge
18h 58m
Merged PRs (30d)
4

Description

## UPDATE: New Summary

We've decided that we won't be reinstating the functionality described in the original summary. The reason for this is that changes made through direct file edits in github don't go through our usual CI actions.

The new requirement is to remove every instance of the 'contribute' value at the top of each markdown file. And, if there's any vestigial code left for the 'edit this page on github' to remove that as well

## Summary

The 'Edit this page on GitHub' links were broken, therefore were removed.

The links need to be added back in and to be fixed, so that they link to the correct pages. Therefore users will not fail when contributing.

## 💬 Description

The feature should be added back in so that users of the site are able to edit the page. This should be an easy process and enable the user to submit a pull request so that the team are able to review and add in the feature.

## 💰 Use value

Enable more users of the site to contribute directly.

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

Search the Guidance site’s markdown files for every instance of the "contribute" value, then inspect related site code for vestigial "edit this page on GitHub" functionality. Confirm that the old links and associated code are removed, and verify the site still builds successfully.

Written by the indexing model from the issue text.

Assessment

Tech stack
github, markdown
Domain
documentation
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.