Skip to content

Conversation

@oredavids
Copy link
Contributor

@oredavids oredavids commented Jan 4, 2022

@netlify
Copy link

netlify bot commented Jan 4, 2022

✔️ Deploy Preview for pensive-meitner-faaeee ready!

🔨 Explore the source changes: 06db35f

🔍 Inspect the deploy log: https://app.netlify.com/sites/pensive-meitner-faaeee/deploys/61d4a91657c7d8000740bae3

😎 Browse the preview: https://deploy-preview-124--pensive-meitner-faaeee.netlify.app

Copy link
Contributor

@ebeneliason ebeneliason left a comment

Choose a reason for hiding this comment

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

As best I can tell, the changes in this PR fall into 3 categories:

  1. Indenting code blocks which reside inside lists
  2. Switching to use of 1. for all items in numbered lists
  3. Changing the link format of some links in list items

(1) seems straightforward. (2) shouldn't, as I understand it, actually have an impact on the output. Does it? Do we definitely want to adopt that convention universally? I don't understand the rationale for (3). Is that an incidental change, or does the format of the link change the way it gets processed in some way? If so, how would we make it obvious to authors what format to use?

@oredavids
Copy link
Contributor Author

oredavids commented Jan 4, 2022

@ebeneliason
(2) The use of 1. has no impact on output. I made the change because we had most of the numbered lists using that within the RefArch guide. I think we should adopt this universally because items can be inserted without the need to change numbering for subsequent items.

(3) I made a change to the link format so that it works in Github as well as Docusaurus. We made this change in other guides before the holidays but didn't do this for the Refarch because it was migrated earlier.

Copy link
Contributor

@ebeneliason ebeneliason left a comment

Choose a reason for hiding this comment

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

Thanks for the clarifications on those changes. Looks good to me, although admittedly I didn't scour everything to be sure none were missed, so I'm trusting you/regex on comprehensiveness.

@oredavids oredavids merged commit e5805a2 into master Jan 4, 2022
@oredavids oredavids deleted the apt-1630-refarch-list-fix branch January 4, 2022 23:07
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.

2 participants