changing the broken link https://docs.battlesnake.com/community/contributing page to the contribution guideline page https://web.archive.org/web/20220526045103/https://docs.battlesnake.com/community/contributing

Now that Heroku's free tier is gone, Railway has become my go-to recommendation to new users.

Removed Heroku - Free tier is no more, don't think it warrants a recommendation anymore.

Replaced with Railway - Similar system to Heroku, free tier is great, developer tier is free for majority of snakes, just needs credit card to prevent fraud. Very helpful support channels in Discord, easy to get started for people who are new to hosting. Would put it above DigitalOcean if they weren't partnered with BattleSnake

This fixes #2

This was done with create-docusarus with the following command:

npx create-docusaurus@latest . classic

Also added the Github Actions for building on PRs and deploying on commits to main. They are basically copied from the docs here: https://docusaurus.io/docs/deployment#triggering-deployment-with-github-actions

Decisions

I did have to make a few decisions here that I think could be worth discussing:

1. npm By default this is using npm while most of the Docusarus docs (and the readme before I edited it) mention yarn. I'm more used to yarn personally but don't have a strong preference. Do we want to switch and use yarn instead?
2. Typescript? Again by default this is not using Typescript, but the create-docusarus supports it. I thought it might make sense to use JS here to lower the burden for people contributing. But if there is want to do Typescript we can
3. Node Version. I picked 18.4.0 to use locally since that's the most recent 18.x release, but can do 16 LTS or something if anyone has preferences

Add a CODEOWNERS file to help facilitate review of PRs

Currently it has the community-moderators Team as the default CODEOWNERS for the entire repo, plus some other members from Discord who wanted to be included.

This will likely change as the Docs site expands

Changed "shown below" to "shown here" with a link to the customizations page. I don't think just the free options should be shown, users should be able to go straight to the customizations page and see what they've unlocked instead.

Resolves #23

This closes #4

Commitlint did not allow overriding the error messages, however it allowed custom rules (with custom errors) which is the approach I chose. I only implemented 4 rules for now.

it's recommended that commitlint runs on the commit-msg git hook, to make sure this happened husky was added to make sure that the hooks are properly configured and automatically after npm install.

Rules:

docs/no-type & docs/no-scope

These 2 rules disallows the use of the type and scope which is used in the conventional commit standard. these will create an error if they are found in the commit message

docs/header-length

This rule will warn if the header is longer than 50 characters long

docs/body-blank-line

This rule will warn if there is no blank line between the body and header

Questions

1. Are we missing any rules?
2. How much info should each warning/error provide? (multiline, colors, bold, italic and more is possible)
3. Should we extend the contributing guide to include a section about git commit messages?

Adding PowerShell starter project to community starter projects.

I noticed it had dropped off the list of community starter projects.

Previously added on what is now old-docs https://github.com/BattlesnakeOfficial/docs-old/pull/33. Not sure if it was unlucky timing with the move to new doc or if it has been purposely removed.

Using this a way to test my 'real' PR here: https://github.com/BattlesnakeOfficial/docs-new/pull/5

Doing to merge this to my fork with the org name change and make sure it deploys well!

This PR fixes 2 admonitions under guides which did not show properly. Wasn't sure which admonition to use for the battlegrounds one, went with the info.

This PR replaced the placeholder content in the default Docusaurus meta tags regarding the site title and description with Battlesnake specific content.