Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add links to issue impact #4207

Closed

Conversation

ortonpaul
Copy link
Contributor

Add links to the Issues Impact page at a few spots in the documentation in response to #3942. Let me know if there are other places you can think of that make sense 👍🏼

@ortonpaul ortonpaul requested a review from a team as a code owner October 20, 2023 18:14
@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.


Paul Orton seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

@straker
Copy link
Contributor

straker commented Oct 20, 2023

Thanks for the pr. The docs/rule-descriptions.md file is a generated file and so your changes will not keep. Instead you'll need to update the file that generates it which is https://github.com/dequelabs/axe-core/blob/develop/build/configure.js. Specifically you'll need to modify the impact variable to add the links to the specific impact levels.

However, that'll add a lot of duplicate links to the page, so we should discuss with @WilcoFiers how we want to handle that.

@ortonpaul
Copy link
Contributor Author

Ahhh I see! Thanks for the heads up. Maybe a link in the table header then or a footnote somewhere?

Copy link
Contributor

@WilcoFiers WilcoFiers left a comment

Choose a reason for hiding this comment

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

@ortonpaul Thank you for the contribution, but I think this is a little much. One link in the API.md file, and one link in the rule description file is probably enough. As Steve pointed out the rule description file is generated. To update it you'll have to change some code in build/configure.js.

You may also want to consider putting a link into the readme somewhere. I'm open to suggestions on where.

@straker
Copy link
Contributor

straker commented Jan 12, 2024

@ortonpaul are you still interested in doing this work or could I close the pr?

straker added a commit that referenced this pull request Jan 15, 2024
#4300)

Just adding a code comment to the `rule-descriptions.md` file to note
that it is a generated file. Spawned from a discussion in
#4207 (comment).
@straker
Copy link
Contributor

straker commented Feb 1, 2024

Closing due to inactivity

@straker straker closed this Feb 1, 2024
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.

None yet

4 participants