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

FINAL: Glossary generation in rules & reverse linking in algorithms #147

Merged
merged 7 commits into from Jun 14, 2018

Conversation

jeeyyy
Copy link
Collaborator

@jeeyyy jeeyyy commented May 29, 2018

Checklist for Pull Request

🚨Please review the guidelines for contributing to this repository.

  • Make sure you are requesting to pull a issue/feature/bugfix branch (right side). Don't request your master branch!
  • Make sure you are making a pull request against the master branch (left side). Also you should start your branch off master branch.
  • Kindly prefix the pull request name with DRAFT or FINAL accordingly. For more details, read Rule Design Guidelines
  • Provide a reference to the issue being addressed.

#Reviewing Guidelines

  • For DRAFT PR's, leave any comments you have and approve if you’ve reviewed the entire pull request.
  • Once there have been three such reviews the pull request can be merged.
  • Any comments left will be taken up in an updated pull request, which will be necessary before a FINAL release”.
  • For FINAL PR's, review and approve changes to be merged.

How to Review And Approve

  • Go to the “files changed” tab, there you will have the option to leave comments on different lines.
  • Once the review is completed, find the “Review changes” button in the top right, select “approve” and click “Submit review”

Description

  • Generation of all used definitions at the bottom of each rule/ drafts
  • Generation of reverse backlinks to rules from each definition or algorithm
  • all definitions need not be added as hyperlinks anymore, they get auto-generated usage is as below:
The first `title` element contains [non-empty text](#non-empty).
**[text in hyperlink](#name-of-algorithm)**

Note: The hash (#) symbol in hyperlink url is crucial.
image

image
image

💔Thank you!

@jeeyyy
Copy link
Collaborator Author

jeeyyy commented May 29, 2018

@annethyme
As requested and discussed on Monday, the definitions/ algorithms are now auto-generated in each rule/ draft & vice-versa in the algorithms page the relevant rules in which they are used are enlisted.
Hopefully this should accelerate the work necessary with algorithms.

Copy link
Contributor

@kasperisager kasperisager left a comment

Choose a reason for hiding this comment

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

Looks great, kudos! 👍 for explicitly assigning keys to algorithm definitions.

Copy link
Member

@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.

Please update to use the file name instead of key.

@jeeyyy jeeyyy moved this from Final (Needs Review) to Auto-Wcag (Pre Publish Review) in Rules Progress Overview Jun 11, 2018
Copy link
Collaborator

@annethyme annethyme left a comment

Choose a reason for hiding this comment

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

I like the result. Have no clue about code quality though.

@jeeyyy jeeyyy merged commit 06730de into master Jun 14, 2018
@jeeyyy jeeyyy deleted the layout-updated-and-glossary-for-algorithms branch June 14, 2018 14:24
@annethyme annethyme moved this from Auto-Wcag (Pre Publish Review) to Completed in Rules Progress Overview Jun 18, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

None yet

5 participants