Skip to content

Commit 5e27cd6

Browse files
feat: add community and contribution section
1 parent 6e34fd6 commit 5e27cd6

File tree

9 files changed

+68
-10
lines changed

9 files changed

+68
-10
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Thank you for helping improve Cosmify Docs! Here’s how you can contribute:
1414
```bash
1515
yarn install
1616
```
17-
4. **Make Changes**: Edit the necessary files inside the `docs` folder.
17+
4. **Make Changes**: Edit the necessary files inside the `content` folder.
1818
5. **Run Locally**:
1919
```bash
2020
yarn dev

components/content/ProseA.vue

Whitespace-only changes.

components/content/ProseCode.vue

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
<template>
2-
<code>
2+
<code
3+
class="relative rounded bg-muted px-[0.3rem] py-[0.2rem] font-mono text-sm font-semibold"
4+
>
35
<slot />
46
</code>
57
</template>

components/content/ProseOl.vue

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<template>
2+
<ol class="my-6 ml-6 list-decimal list-outside [&li]>mt-2" v-bind="$attrs">
3+
<slot />
4+
</ol>
5+
</template>
6+
7+
<style scoped>
8+
::v-deep li + li {
9+
@apply mt-4;
10+
}
11+
</style>
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
title: "Contributing - Docs"
3+
description: "Thank you for helping improve Cosmify Docs! Here’s how you can contribute:"
4+
---
5+
6+
## Steps to Contribute
7+
8+
1. **Fork the Repository**: Click `Fork` at the top-right of [this repo](https://github.com/cosmify-dev/docs).
9+
10+
2. **Clone Your Fork**:
11+
```bash
12+
git clone https://github.com/your-username/docs.git
13+
cd docs
14+
```
15+
16+
3. **Install Dependencies**:
17+
```bash
18+
yarn install
19+
```
20+
21+
4. **Make Changes**: Edit the necessary files inside the `content` folder.
22+
23+
5. **Run Locally**:
24+
```bash
25+
yarn dev
26+
```
27+
Preview changes at `http://localhost:3000`.
28+
29+
6. **Commit & Push** (Follow [Semantic Commit Messages](https://www.conventionalcommits.org/en/v1.0.0/)):
30+
```bash
31+
git add .
32+
git commit -m "feat: update documentation structure"
33+
git push origin your-branch
34+
```
35+
36+
7. **Create a Pull Request**: Open a PR on GitHub from your fork.
37+
38+
## Guidelines
39+
- Keep edits clear and concise.
40+
- Follow existing formatting.
41+
- Ensure correct spelling and grammar.
42+
43+
Thank you for contributing! 🚀

content/docs/2.setting-up/test.md

Lines changed: 0 additions & 6 deletions
This file was deleted.

nuxt.config.ts

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,12 @@ export default defineNuxtConfig({
3030
nitro: {
3131
static: true,
3232
prerender: {
33-
routes: ["/sitemap.xml", "/", "/docs/getting-started/installation"],
33+
routes: [
34+
"/sitemap.xml",
35+
"/",
36+
"/docs/getting-started/installation",
37+
"/docs/community/contribute-docs",
38+
],
3439
},
3540
},
3641
content: {

pages/docs/[...slug].vue

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,9 @@ const { data: documentationRoutes } = await useAsyncData("navigation", () => {
8383
</div>
8484
<div v-if="page">
8585
<ProseH1>{{ page.title }}</ProseH1>
86+
<p class="text-xl text-muted-foreground mt-2" v-if="page.description">
87+
{{ page.description }}
88+
</p>
8689
<br />
8790
<ContentRenderer v-if="page" :value="page" :prose="true" />
8891
</div>

tailwind.config.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ const animate = require("tailwindcss-animate");
33
/** @type {import('tailwindcss').Config} */
44
module.exports = {
55
darkMode: ["class"],
6-
safelist: ["dark"],
6+
safelist: ["dark", "list-decimal"],
77
prefix: "",
88
theme: {
99
container: {

0 commit comments

Comments
 (0)