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 some docs links and README links #92

Merged
merged 3 commits into from
Apr 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Contributing

See [contributing.md](/docs/docs/contributing.md) in the docs.
See the [contributing guide](https://jury.mikz.dev/docs/contributing) on our documentation site!
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@

A project designed to create a new pairwise judging system using modern technologies, aimed at optimizing the user experience of judges, hackers, and organizers. See the inspiration for this project: [Gavel by anishathalye](https://github.com/anishathalye/gavel). This project uses an individual ranking and rank aggregation system to automate the judging process and help organizers get more data from less judges to decide the winners of your hackathon.

To get started, check out the [intro guide](./docs/docs/intro.md).
To get started, check out the [Jury documentation](https://jury.mikz.dev).

# Contributing

Check out [our contributing docs](/CONTRIBUTING.md).
Check out [our contributing docs](https://jury.mikz.dev/docs/contributing).
2 changes: 1 addition & 1 deletion docs/docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ You can change the [subdomain](https://en.wikipedia.org/wiki/Subdomain) of the U
- Change app name (URL will be `<app_name><some_characters>.ondigitalocean.app`)
- Click Next

You may also want to set up a custom domain name for your application (see [below](#optional-step-custom-domain)).
You may also want to set up a custom domain name for your application (see [below](#custom-domain-name)).

## Step 5. Done!

Expand Down
8 changes: 4 additions & 4 deletions docs/docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -75,15 +75,15 @@ const config: Config = {
items: [
{
label: 'Contributing',
to: '/docs/intro',
to: '/docs/contributing',
},
{
label: 'API Reference',
to: '/docs/api',
label: 'Public API',
to: '/docs/reference/public-api',
},
{
label: 'Internal API Reference',
to: '/docs/backend',
to: '/docs/reference/internal-api',
},
],
},
Expand Down