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

Fix broken docs links and nested Markdown list #3249

Merged
merged 2 commits into from
Mar 5, 2024

Conversation

eneiss
Copy link
Contributor

@eneiss eneiss commented Mar 5, 2024

What type of PR is this?

  • documentation

What this PR does / why we need it:

/docs/docs/contributors/developers-guide/code-contributions.md:

  • Fix Github Flow broken links: current links are no longer valid and redirect to Github's home page. I replaced them with what I believe is their new version.
  • Fix Facebook's Draft broken link: I'm not too sure about this one since the current link points at a specific version of the CONTRIBUTING.md of Facebook's draft-js repo, and this version is no longer available.
    Instead, I chose to target the link to the version on the main branch of the now-archived repository. Since it is now read-only, this shouldn't be an issue. If you believe I should do it differently, please let me know :)
  • Fix a Mardown list that should've been nested according to the indentation in the source file (it also makes more sense this way), but is currently rendered at the top level instead.

Which issue(s) this PR fixes:

No linked issue, let me know if I should create one!

Testing

I tested the code locally (dev container) with mkdocs serve to make sure the links and nested list were rendering as expected.

@boc-the-git
Copy link
Collaborator

Thanks for your first PR @eneiss !

We're fine without an issue, so no worries there.

I can't actually look at the change properly now (and understand the markdown rules) but I should get to it at least within 48 hours, if someone doesn't see it sooner.

Copy link
Collaborator

@boc-the-git boc-the-git left a comment

Choose a reason for hiding this comment

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

LGTM

@boc-the-git boc-the-git merged commit 9f3aca5 into mealie-recipes:mealie-next Mar 5, 2024
9 checks passed
@eneiss eneiss deleted the fix-doc-links branch March 5, 2024 16:35
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.

None yet

2 participants