Skip to content

Chore/trailing slashes cleanup#2409

Open
briwylde08 wants to merge 2 commits into
mainfrom
chore/trailing-slashes-cleanup
Open

Chore/trailing slashes cleanup#2409
briwylde08 wants to merge 2 commits into
mainfrom
chore/trailing-slashes-cleanup

Conversation

@briwylde08

Copy link
Copy Markdown
Contributor

No description provided.

@stellar-jenkins-ci

Copy link
Copy Markdown

@JFWooten4

Copy link
Copy Markdown
Contributor

Re @ElliotFriend in #2583 (comment) - keeping the thread going to merge this. You can see the original logic inspiring these changes in #2396. That logic hinged around easing the review scanning lifecycle to fix an example error in JFWooten4@425749f.

I like that trailingSlash is false in the Docusaurus config a lot. In my regulatory drafting, many government sources don't include that, and it makes direct URLs look stylistically abysmal in final compilations. I've implemented tooling to bulk remove them at no consequential procedural cost, because they led to a factual error and incorrect citation in my last comment.

With the larger focus on internal docs links, I think this reinforces a standard of clean code. The internal .mdx#{tag} refs don't use trailing slashes, and neither should external page refs. I've made style difference changes like that before in github/.github#447, and I guess you could say they're from my instinct as a writer for the last decade more than a definitive source.

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