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

Replace README with a link to Docusaurus page #376

Closed
wants to merge 1 commit into from

Conversation

thijsvanloef
Copy link
Owner

Context

Since we are using docusaurus, I want to use a single place to store all of the documentation.
This way we do not need to keep updating the README.md in github and only the docusaurus documentation.

Choices

I decided to do this since the docusaurus is easier to navigate and has a search function, in my opinion this makes it easier for people to find what they need.

Test instructions

Click on the link, navigate to https://palworld-server-docker.loef.dev/

Checklist before requesting a review

  • I have performed a self-review of my code
  • I've added documentation about this change to the README.
  • I've not introduced breaking changes.

@thijsvanloef thijsvanloef added the documentation Improvements or additions to documentation label Feb 12, 2024
@thijsvanloef thijsvanloef self-assigned this Feb 12, 2024
@thijsvanloef thijsvanloef deleted the replace-readme branch February 13, 2024 17:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant