Skip to content

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

Merged
merged 12 commits into from
Jan 3, 2025
Merged

docs: markdown fixes and edits #15527

merged 12 commits into from
Jan 3, 2025

Conversation

angrycub
Copy link
Contributor

@angrycub angrycub commented Nov 15, 2024

  • docs: improve admonition for need to add useHttpPath
  • docs: fix list item nesting
  • docs: fix list item nesting
  • docs: improve admonition for authentication
  • docs: tidy and update vault guide
  • docs: improve admonitions
  • docs: improve admonitions
  • docs: content edits, reference links to make copy easier to read

previews:

@angrycub angrycub added the docs Area: coder.com/docs label Nov 15, 2024
@angrycub angrycub requested a review from matifali November 15, 2024 03:51
@angrycub angrycub self-assigned this Nov 15, 2024
Copy link
Member

@matifali matifali left a 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.


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.
Copy link
Member

Choose a reason for hiding this comment

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

Incorrect link format.

Copy link
Contributor

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

Copy link
Contributor

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

@angrycub
Copy link
Contributor Author

angrycub commented Nov 15, 2024 via email

@github-actions github-actions bot added the stale This issue is like stale bread. label Nov 26, 2024
@github-actions github-actions bot closed this Nov 30, 2024
@EdwardAngert EdwardAngert reopened this Jan 3, 2025
@EdwardAngert EdwardAngert removed the stale This issue is like stale bread. label Jan 3, 2025
@EdwardAngert
Copy link
Contributor

EdwardAngert commented Jan 3, 2025

re-opened and ran make fmt and make lint - most alignment things should be cleaned up with the new process, but it looks like some things did slip through

screenshot

2025-01-03_13-43-34

throwing in some fixes then 👍 🚀

@EdwardAngert EdwardAngert requested a review from matifali January 3, 2025 18:52
@EdwardAngert EdwardAngert merged commit 4e09639 into main Jan 3, 2025
27 checks passed
@EdwardAngert EdwardAngert deleted the fix-guides-list-numbers branch January 3, 2025 19:13
@github-actions github-actions bot locked and limited conversation to collaborators Jan 3, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
docs Area: coder.com/docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants