Skip to content

Commit 527fcc9

Browse files
authored
Switch to Mintlify (supabase-community#52)
1 parent 1cc1334 commit 527fcc9

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

71 files changed

+777
-16568
lines changed

.gitignore

-20
This file was deleted.

CONTRIBUTING.md CONTRIBUTING.mdx

+21-8
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
# Contributing
1+
---
2+
title: CONTRIBUTING.md
3+
description: Best practices to contribute to launchweek.dev
4+
---
25

36
So you want to contribute to this repo? Awesome!
47

@@ -7,7 +10,7 @@ We welcome every contribution. To do so, you have two options:
710
1. [Create an issue](#create-an-issue) or
811
2. [Open a Pull Request (PR)](#open-a-pull-request)
912

10-
## Create an issue
13+
## create an issue
1114

1215
There are multiple ways to create an issue. Below is how to create an issue from the repository. For more information, see "[Creating an issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-an-issue)."
1316

@@ -18,15 +21,25 @@ There are multiple ways to create an issue. Below is how to create an issue from
1821
6. In the comment body field, type a description of your issue
1922
7. When you're finished, click **Submit new issue**
2023

21-
## Open a Pull Request
24+
<Card title="Creating an issue" icon="github" href="https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/creating-an-issue">
25+
Keep track of bugs, enhancements, or other requests with Issues.
26+
</Card>
27+
28+
## open a Pull Request
2229

2330
For more information, see "[Creating a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)."
2431

25-
## Additional notes
32+
<Card title="Creating a Pull Request" icon="github" href="https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request">
33+
Create a Pull Request to propose and collaborate on changes to a repository.
34+
</Card>
35+
36+
---
37+
38+
## guidelines
2639

27-
Some guidelines:
40+
Some additional notes:
2841

29-
- Add one launch week per PR
42+
- Add one launch week per <Tooltip tip="Pull Request">PR</Tooltip>
3043
- Make sure the PR title is in the following format: `Add {product} Launch Week`
3144
- Add the launch week:
3245
```
@@ -40,9 +53,9 @@ Some guidelines:
4053
`[Read the announcement ↗︎](https://)`
4154
`[Read the recap ↗︎](https://)`
4255
- Launch page:
43-
`[Go to launch page ↗︎](https://)`
56+
`[Go to launch page ↗︎](https://)`
4457
- Check your spelling and grammar
4558
- Remove any trailing whitespace
4659
- Content must be in English
4760

48-
Thank you for making this repo more awesome! Enjoy!
61+
**Thank you for making this repo more awesome! Enjoy!**

LICENSE

-21
This file was deleted.

README.md

-186
This file was deleted.

README.mdx

+64
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
---
2+
title: README.md
3+
description: Tracking launch weeks across the industry, for product discovery and inspiration.
4+
---
5+
6+
## about
7+
8+
What's a launch week? It's a week of announcing new features.
9+
10+
**This repository tracks past and upcoming launch weeks across the dev tools space.**
11+
12+
## objectives
13+
14+
**For developers**
15+
16+
To save the date and discover awesome developer-first products.
17+
18+
**For dev tools founders and marketers**
19+
20+
To help plan and promote their launch weeks and find inspiration.
21+
22+
## want to contribute?
23+
24+
Awesome! Feel free to [create an issue](https://github.com/supabase-community/launchweek.dev/issues) or open a [Pull Request (PR)](https://github.com/supabase-community/launchweek.dev/pulls) to add more launch weeks.
25+
26+
<Card title="CONTRIBUTING.md" href="CONTRIBUTING.md">
27+
Best practices to contribute to launchweek.dev
28+
</Card>
29+
30+
[launchweek.dev](https://launchweek.dev) is powered by [Mintlify](https://mintlify.com), a Next.js-based platform for documentation sites. Every page is a `.mdx` file, written in Markdown, with built-in UI components.
31+
32+
The live site updates through this GitHub repo:
33+
34+
<Card title="supabase-community/launchweek.dev" href="https://git.new/lw">
35+
launchweek.dev on GitHub
36+
</Card>
37+
38+
To preview local changes, you need to install the [Mintlify CLI](https://www.npmjs.com/package/mintlify). Run this:
39+
```
40+
npm i -g mintlify
41+
```
42+
43+
Then run the following command at the root of your local folder, where the `mint.json` file is:
44+
```
45+
mintlify dev
46+
```
47+
48+
---
49+
50+
This project is maintained by:
51+
<CardGroup cols={2}>
52+
<Card title="Paul Copplestone" href="https://x.com/kiwicopple" horizontal>
53+
CEO, Supabase
54+
</Card>
55+
<Card title="Flo Merian" href="https://x.com/fmerian" horizontal>
56+
Co-founder, marketingto.dev
57+
</Card>
58+
</CardGroup>
59+
60+
For best practices, read this:
61+
62+
<Card title="How we launch at Supabase (by Ant Wilson)" href="https://supabase.com/blog/supabase-how-we-launch">
63+
The history and methodology of Supabase Launch Week
64+
</Card>

assets/.DS_Store

6 KB
Binary file not shown.

assets/brand/.DS_Store

6 KB
Binary file not shown.

assets/brand/supabase-logo-icon.svg

+15
Loading
Loading
Loading

assets/brand/supabase-og-image.png

70.9 KB
Loading

assets/vecs/checks-passed.png

157 KB
Loading

0 commit comments

Comments
 (0)