-
Notifications
You must be signed in to change notification settings - Fork 875
docs: markdown fixes and edits #15527
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @angrycub for doing this.
I will leave the content review to @EdwardAngert.
docs/admin/integrations/island.md
Outdated
|
||
1. [Create a URL Object](https://documentation.island.io/docs/create-and-configure-a-policy-rule-general) | ||
with the following configuration: | ||
1. [Create a URL Object][policy-rule] with the following configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Incorrect link format.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are we not allowed to use markdown reference links? It certainly improves both readability and reuse when they are used rather than inline links.
@angrycub you're not and it's not wrong - I think we stick with inline since the benefits of reference are a bit marginal in comparison. We don't usually need to reuse links within the same doc (or shouldn't need to, really), and as we start to encourage more contributors, I prefer to keep it as approachable (and in-line) as possible
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks for submitting this, @angrycub!
looking at the original next to the preview, aside from the beautifully realigned list items 🙌 , everything else looks the same.
For me, as I'm reading through the documentation "code," reference links force me to context switch and the “last mile”
things knock me out of flow - reading the same sentence a few times. If there's something about the reference links or encoding that makes the docs easier to parse, I'd love to figure out a way we can make it better there, otherwise, I can push a commit to this branch to clean up the md a bit
Are we not allowed to use markdown reference links? It certainly improves
both readability and reuse when they are used rather than inline links.
…On Fri, Nov 15, 2024 at 1:02 AM Muhammad Atif Ali ***@***.***> wrote:
***@***.**** requested changes on this pull request.
Thanks @angrycub <https://github.com/angrycub> for doing this.
I will leave the conent review to @EdwardAngert
<https://github.com/EdwardAngert>.
------------------------------
In docs/admin/integrations/island.md
<#15527 (comment)>:
>
-1. [Create a URL Object](https://documentation.island.io/docs/create-and-configure-a-policy-rule-general)
- with the following configuration:
+1. [Create a URL Object][policy-rule] with the following configuration.
Incorrect link format.
—
Reply to this email directly, view it on GitHub
<#15527 (review)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AADRM3BUYJ5I43SUJPXFBC32AWFAJAVCNFSM6AAAAABR2KAFFWVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDIMZXG4YDQOBXGI>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
previews: