Skip to content

Commit

Permalink
basic getting started doc
Browse files Browse the repository at this point in the history
  • Loading branch information
tommerty committed Nov 7, 2023
1 parent bfdee81 commit 1d0f490
Show file tree
Hide file tree
Showing 8 changed files with 120 additions and 40 deletions.
12 changes: 6 additions & 6 deletions astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -10,23 +10,23 @@ export default defineConfig({
integrations: [starlight({
title: 'Doras.to',
editLink: {
baseUrl: 'https://github.com/gezelio/docs.doras.to/edit/master/',
baseUrl: 'https://github.com/doras-to/docs/edit/master/',
},
social: {
github: 'https://github.com/gezelio/docs.doras.to'
github: 'https://github.com/doras-to/docs'
},
sidebar: [{
label: 'Guides',
items: [
// Each item here is one entry in the navigation menu.
{
label: 'Example Guide',
link: '/guides/example/'
label: 'Getting Started',
link: '/guides/getting-started/'
}]
}, {
label: 'Reference',
label: 'Contributing',
autogenerate: {
directory: 'reference'
directory: 'contributing',
}
}]
}), react(), tailwind()]
Expand Down
30 changes: 29 additions & 1 deletion public/favicon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
29 changes: 29 additions & 0 deletions src/assets/favicon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 5 additions & 5 deletions src/content/docs/contributing/contribute-to-the-docs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ If you contribute to the docs, we'll add your GitHub to the article at the botto
---

## Writing a new article
If you wish to write a new article, it's best to head over to [GitHub](https://github.com/gezelio/docs.doras.to) and create a new branch. To then create your new article:
If you wish to write a new article, it's best to head over to [GitHub](https://github.com/doras-to/docs) and create a new branch. To then create your new article:

### Creating your file
Head over to `src/content/docs` and you can see folders, such as `getting-started`. These are the categories that the articles are sorted into. If you wish to create a new category, you can do so by creating a new folder. If you wish to add an article to an existing category, you can do so by creating a new file in the category folder.
Expand Down Expand Up @@ -49,7 +49,7 @@ My article content goes here.
{/* END OF ARTICLE. PLEASE DON'T EDIT BELOW THIS LINE */}
---
Thank you to our contributors
<iframe src="https://github.com/gezelio/docs.doras.to/graphs/contributors-widget?width=500&height=200&background=none" width="500" height="200" frameborder="0"></iframe>
<iframe src="https://github.com/doras-to/docs/graphs/contributors-widget?width=500&height=200&background=none" width="500" height="200" frameborder="0"></iframe>
```

:::note[Why "community"?]
Expand All @@ -70,15 +70,15 @@ Write your article below the `WRITE YOUR ARTICLE BELOW THIS` comment. You can us
The following step is optional and if you're not confident to do it, just let us know when you submit your PR!
:::

We'll need to then add your new article to the sidebar, as this doesn't happen automatically. To do this, head over to [astro.config.mjs](https://github.com/gezelio/docs.doras.to/blob/master/astro.config.mjs) and under `sidebar` and sort your article into the correct category. For example, if you created a new article in the `getting-started` folder, you'd add it under this, following the existing formatting.
We'll need to then add your new article to the sidebar, as this doesn't happen automatically. To do this, head over to [astro.config.mjs](https://github.com/doras-to/docs/blob/master/astro.config.mjs) and under `sidebar` and sort your article into the correct category. For example, if you created a new article in the `getting-started` folder, you'd add it under this, following the existing formatting.

### Submitting the change
Once you're done, you can submit a pull request and we'll review your article. We may ask you to make some changes before we merge your pull request, but if there's any quick problems we can quickly solve, we'll do so ourselves to save you the hassle and get your article out there!

## Important to know...
You can always take a look at existing articles to see how they're formatted. If you're unsure about anything, feel free to ask in our [Discord](https://gezel.io/discord) or [open an issue on GitHub](https://github.com/gezelio/docs.doras.to/issues) and we'll be happy to help!
You can always take a look at existing articles to see how they're formatted. If you're unsure about anything, feel free to ask in our [Discord](https://gezel.io/discord) or [open an issue on GitHub](https://github.com/doras-to/docs/issues) and we'll be happy to help!

---
#### Thank you to our contributors
<iframe src="https://github.com/gezelio/docs.doras.to/graphs/contributors-widget?width=500&height=200&background=none" width="500" height="200" frameborder="0">
<iframe src="https://github.com/doras-to/docs/graphs/contributors-widget?width=500&height=200&background=none" width="500" height="200" frameborder="0">
</iframe>
13 changes: 13 additions & 0 deletions src/content/docs/contributing/contribute-to-the-site.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: Contributing to the main site
description: Help improve our documentation by writing to the docs.
---

import {Author} from '../../../components/Author';
import { LinkCard, CardGrid } from '@astrojs/starlight/components';

<Author author="Tommerty"/>

---

coming soon
10 changes: 0 additions & 10 deletions src/content/docs/guides/example.mdx

This file was deleted.

25 changes: 25 additions & 0 deletions src/content/docs/guides/getting-started.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
title: Getting Started with Doras
description: Doras.to is a platform to help creators share their presence online. With tools such as our Link in Bio, link shortening, and more, we help creators share their content with their audience.
---

import {Author} from '../../../components/Author';
import { LinkCard, CardGrid } from '@astrojs/starlight/components';

<Author author="Tommerty"/>

# Welcome to Doras! 🚀
Doras is a fully featured platform to help creators share their presence online. With tools such as our Link in Bio, link shortening, and more, we help creators share their content with their audience. Let's get you started!

### Creating an Account
On Doras, it's really simple to get started. First, head over to the [sign up page here](https://admin.doras.to/signup). You'll be greeted with a form that looks like this (please note that this picture is from pre-release and may look slightly different):

[![Sign Up Form](https://gezel.b-cdn.net/doras/docs/Screenshot%202023-11-07%20at%2020.26.59.png)](https://admin.doras.to/auth)

You can choose to sign up via SSO such as Discord, Twitch or X.com, or you can manually create an account with the form.

:::tip[Don't worry!]
If you signed up via SSO, you will be prompted to choose your username after you create your account, and can change to a email/password at any time.
:::

Once you're signed in, don't forget to check your email. You should have an email from `[email protected]` to verify your email address. If you don't see it, check your spam folder. If you're certain it's not there, please drop us a message on [Discord](https://gezel.io/discord) or open an issue on [GitHub](https://github.com/doras-to/doras/issues) and we'll help you out, just let us know your username!
31 changes: 13 additions & 18 deletions src/content/docs/index.mdx
Original file line number Diff line number Diff line change
@@ -1,36 +1,31 @@
---
title: Welcome to Starlight
title: Doras Docs
description: Get started building your docs site with Starlight.
template: splash
hero:
tagline: Congrats on setting up a new Starlight project!
tagline: For help with all things Doras
image:
file: ../../assets/houston.webp
file: ../../assets/favicon.svg
actions:
- text: Example Guide
link: /guides/example/
- text: Go to the docs
link: /guides/getting-started/
icon: right-arrow
variant: primary
- text: Read the Starlight docs
link: https://starlight.astro.build
- text: Head to Doras
link: https://doras.to
icon: external
---

import { Card, CardGrid } from '@astrojs/starlight/components';

## Next steps

<CardGrid stagger>
<Card title="Update content" icon="pencil">
Edit `src/content/docs/index.mdx` to see this page change.
</Card>
<Card title="Add new content" icon="add-document">
Add Markdown or MDX files to `src/content/docs` to create new pages.
<Card title="Search is your friend" icon="magnifier">
The searchbox is the best place to find anything. It's quick, powerful, and will help you find what you need.
</Card>
<Card title="Configure your site" icon="setting">
Edit your `sidebar` and other config in `astro.config.mjs`.
<Card title="Community Driven Documentation" icon="github">
The docs are written by the community, and validated by the community & administration to ensure integrity. Want to contribute? [Learn how](/contributing/contribute-to-the-docs/).
</Card>
<Card title="Read the docs" icon="open-book">
Learn more in [the Starlight Docs](https://starlight.astro.build/).
<Card title="Join the community" icon="discord">
We have an active community to ask any questions the docs might not answer! Head over [to our Discord](https://gezel.io/discord) and ask away!
</Card>
</CardGrid>

0 comments on commit 1d0f490

Please sign in to comment.