Merge pull request #28 from theam/LLM-307/review-contributing-and-COD…

…-documentation Removed redundant symlink and fixed double header issue by hiding the one from the original markdown files.
theam · Jul 19, 2023 · 304db80 · 304db80
2 parents 57df796 + 843cd18
commit 304db80
Show file tree

Hide file tree

Showing 6 changed files with 28 additions and 7 deletions.
diff --git a/website/CONTRIBUTING.md b/website/CONTRIBUTING.md
diff --git a/...ite/docs/contributing/code_of_conduct.mdx → ...ite/docs/04_community/code_of_conduct.mdx b/...ite/docs/contributing/code_of_conduct.mdx → ...ite/docs/04_community/code_of_conduct.mdx
@@ -1,5 +1,7 @@
 import CodeOfConduct from '../../../CODE_OF_CONDUCT.md';
 
-# Code of Conduct
+# Contributor Covenant Code of Conduct
 
+<div class="hiddenh1s">
 <CodeOfConduct/>
+</div>
diff --git a/website/docs/contributing/index.mdx → website/docs/04_community/contributing.mdx b/website/docs/contributing/index.mdx → website/docs/04_community/contributing.mdx
@@ -1,5 +1,7 @@
 import ContributingGuide from '../../../CONTRIBUTING.md';
 
-# Introduction
+# Contributing Guide
 
+<div class="hiddenh1s">
 <ContributingGuide />
+</div>
diff --git a/website/docs/04_community/index.md b/website/docs/04_community/index.md
@@ -0,0 +1,10 @@
+# Community
+
+Community contributions are essential to the development and refinement of eLLMental. You can become a part of the eLLMental community in the following ways:
+
+1. Join the conversation in our [Discord server](https://discord.gg/34cBbvjjAx).
+2. Send us suggestions, questions, or feature requests by creating a [New Issue](https://github.com/theam/ellmental/issues/new).
+3. Look at the [Open Issues](https://github.com/theam/ellmental/issues), choose one that interests you, and start contributing.
+4. Spread the word about eLLMental!
+
+Find detailed instructions and guidelines in the [Contributing Guide](contributing), and make sure to read our [Code of Conduct](code_of_conduct) before you start contributing.
diff --git a/website/sidebars.js b/website/sidebars.js
@@ -26,14 +26,18 @@ const sidebars = {
     // },
     {
       type: 'category',
-      label: 'Contributing',
+      label: 'Community',
       link: {
         type: 'doc',
-        id: 'contributing/index'
+        id: 'community/index'
       },
       items: [
-        'contributing/index',
-        'contributing/code_of_conduct',
+        'community/contributing',
+        {
+          type: 'doc',
+          id: 'community/code_of_conduct',
+          label: 'Code of Conduct'
+        }
       ]
     },
     {

diff --git a/website/src/css/custom.css b/website/src/css/custom.css
@@ -38,3 +38,7 @@
 .navbar__logo {
   height: 1.5rem;
 }
+
+.hiddenh1s > h1 {
+  display: none;
+}