Merge pull request #2 from Codium-ai/update-structure

Add initial structure
Codium-ai · Mar 12, 2024 · fb963e1 · fb963e1
2 parents 34a0252 + a57db3c
commit fb963e1
Show file tree

Hide file tree

Showing 38 changed files with 117 additions and 78 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+.cache/
diff --git a/docs/changelog/index.md b/docs/changelog/index.md
diff --git a/docs/chat/context/index.md b/docs/chat/context/index.md
@@ -0,0 +1,6 @@
+# Choose your Context
+
+Codiumate Chat can work with various of contexts:
+
+1. File context -
+2. Workspace context - 
diff --git a/docs/chat/file-mode/ask.md b/docs/chat/file-mode/ask.md
diff --git a/docs/chat/file-mode/docstring.md b/docs/chat/file-mode/docstring.md
diff --git a/docs/chat/file-mode/enhance.md b/docs/chat/file-mode/enhance.md
diff --git a/docs/chat/file-mode/improve.md b/docs/chat/file-mode/improve.md
diff --git a/docs/chat/file-mode/index.md b/docs/chat/file-mode/index.md
@@ -0,0 +1 @@
+# File Mode
diff --git a/docs/chat/file-mode/quick-test.md b/docs/chat/file-mode/quick-test.md
diff --git a/docs/chat/file-mode/test.md b/docs/chat/file-mode/test.md
diff --git a/docs/chat/index.md b/docs/chat/index.md
@@ -0,0 +1 @@
+# Chat
diff --git a/docs/chat/threads.md b/docs/chat/threads.md
diff --git a/docs/chat/workspace-mode/ask.md b/docs/chat/workspace-mode/ask.md
diff --git a/docs/chat/workspace-mode/commit.md b/docs/chat/workspace-mode/commit.md
diff --git a/docs/chat/workspace-mode/describe.md b/docs/chat/workspace-mode/describe.md
diff --git a/docs/chat/workspace-mode/improve.md b/docs/chat/workspace-mode/improve.md
diff --git a/docs/chat/workspace-mode/index.md b/docs/chat/workspace-mode/index.md
@@ -0,0 +1 @@
+# Workspace Mode
diff --git a/docs/chat/workspace-mode/issues.md b/docs/chat/workspace-mode/issues.md
diff --git a/docs/chat/workspace-mode/recap.md b/docs/chat/workspace-mode/recap.md
diff --git a/docs/chat/workspace-mode/review.md b/docs/chat/workspace-mode/review.md
diff --git a/docs/chat/workspace-mode/update-changelog.md b/docs/chat/workspace-mode/update-changelog.md
diff --git a/docs/commands/index.md b/docs/commands/index.md
diff --git a/docs/context/index.md b/docs/context/index.md
diff --git a/docs/guides/generate-tests-python.md b/docs/guides/generate-tests-python.md
@@ -0,0 +1,4 @@
+# Generate tests for a Python Class
+
+
+Put a YouTube video here
diff --git a/docs/guides/index.md b/docs/guides/index.md
@@ -1,3 +1 @@
-# Guides
-
-## Threads
+# Guides
diff --git a/docs/guides/open-pr.md b/docs/guides/open-pr.md
@@ -0,0 +1,3 @@
+# Open a PR with Codiumate
+
+Put a YouTube video here
diff --git a/docs/index.md b/docs/index.md
@@ -1,9 +1,39 @@
 # Overview
 
-**CodiumAI** analyzes your code and generates meaningful tests to catch bugs before you ship. With CodiumAI, you can easily and quickly create comprehensive test suites that help you ensure the reliability and correctness of your software. It supports all languages!
 
-## Links
-- [Discord community](https://discord.gg/kG35uSHDBc{:target="_blank"})
-- [CodiumAI website](https://codium.ai{:target="_blank"})
-- [Blog](https://www.codium.ai/blog/{:target="_blank"})
-- [Troubleshooting](https://www.codium.ai/blog/technical-faq-and-troubleshooting/{:target="_blank"})
+#### Code, test and review with confidence - your AI mate by CodiumAI
+
+Elevate your coding experience with iterative test generation, intelligent code assistant, and efficient PR reviewer, all smoothly integrated into your development workflow. 
+
+Boost your productivity, code with confidence, and optimize your development process!
+
+## Features
+
+- Generate unit tests suite automatically
+
+- Analyze your code
+
+- Suggest code modifications to improve the performance and correctness of your code
+
+- Find potential bugs in your code and suggest ways to fix them
+
+- Document and enhance your code automatically
+
+- Prepare better for your PR
+
+- Help you improve code quality
+
+## Supported IDEs
+
+Codiumate is supported in [VSCode](https://marketplace.visualstudio.com/items?itemName=Codium.codium) and all [JetBrains IDEs](https://plugins.jetbrains.com/plugin/21206-codiumate--code-test-and-review-with-confidence--by-codiumai)
+
+## Supported Languages
+
+Codiumate is supported in Python, Java, JavaScript, TypeScript, C++, C#, Go, PHP, Ruby, Rust, Scala, Swift and all other languages!
+
+
+## News
+
+...
+
+## Bug Report
diff --git a/docs/test-suite/index.md b/docs/test-suite/index.md
diff --git a/docs/tests/behaviors.md b/docs/tests/behaviors.md
diff --git a/docs/tests/configuration.md b/docs/tests/configuration.md
diff --git a/docs/tests/context.md b/docs/tests/context.md
diff --git a/docs/tests/example-test.md b/docs/tests/example-test.md
diff --git a/docs/tests/how-to-use.md b/docs/tests/how-to-use.md
@@ -0,0 +1,5 @@
+- lens
+- right click
+- command palette
+- codium button JB
+- chat
diff --git a/docs/tests/index.md b/docs/tests/index.md
@@ -0,0 +1,9 @@
+# Test Generation
+
+=== "VSCode"
+
+    Something
+
+=== "JetBrains"
+
+    Something else
diff --git a/docs/tests/running-tests.md b/docs/tests/running-tests.md
diff --git a/docs/tests/supported-languages.md b/docs/tests/supported-languages.md
diff --git a/docs/tests/what-can-i-test.md b/docs/tests/what-can-i-test.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -2,28 +2,64 @@ site_name: Codiumate
 
 nav: 
   - 'index.md'
-  - 'installation/index.md'
-  - 'context/index.md'
-  - 'commands/index.md'
-  - 'guides/index.md'
-  - 'changelog/index.md'
+  - Installation:
+    - 'installation/index.md'
+  - Test Generation:
+    - 'tests/index.md'
+    - What can I test?: 'tests/what-can-i-test.md'
+    - Supported Languages: 'tests/supported-languages.md'
+    - How to use: 'tests/how-to-use.md'
+    - Configuration: 'tests/configuration.md'
+    - Example Test: 'tests/example-test.md'
+    - Behaviors: 'tests/behaviors.md'
+    - Context Preview: 'tests/context.md'
+    - Running Tests: 'tests/running-tests.md'
+  - Chat:
+    - 'chat/index.md'
+    - Choose your Context:
+      - 'chat/context/index.md'
+    - File Mode:
+      - 'chat/file-mode/index.md'
+      - Ask: 'chat/file-mode/ask.md'
+      - Docstring: 'chat/file-mode/docstring.md'
+      - Enahnce: 'chat/file-mode/enhance.md'
+      - Improve: 'chat/file-mode/improve.md'
+      - Test: 'chat/file-mode/test.md'
+      - Quick-Test: 'chat/file-mode/quick-test.md'
+    - Workspace Mode:
+      - 'chat/workspace-mode/index.md'
+      - Ask: 'chat/workspace-mode/ask.md'
+      - Describe: 'chat/workspace-mode/describe.md'
+      - Review: 'chat/workspace-mode/review.md'
+      - Find Issues: 'chat/workspace-mode/issues.md'
+      - Recap: 'chat/workspace-mode/recap.md'
+      - Improve: 'chat/workspace-mode/improve.md'
+      - Update Changelog: 'chat/workspace-mode/changelog.md'
+    - Threads: 'chat/threads.md'
+  - Guides:
+    - 'guides/index.md'
+    - Open a PR with Codiumate: 'guides/open-pr.md'
+    - Generate tests for Python: 'guides/generate-tests-python.md'
 
 theme:
   logo: assets/logo.png
   favicon: assets/favicon.ico
   name: material
   features:
     - navigation.tabs
-    - navigation.sections
     - navigation.expand
-    - toc.integrate
+    - navigation.path
     - navigation.top
+    - navigation.tracking
+    - navigation.indexes
     - search.suggest
     - search.highlight
     - content.tabs.link
     - content.code.annotation
     - content.code.copy
     - toc.integrate
+    - content.tabs.link
+  language: en
   language: en
   custom_dir: overrides
 
@@ -88,6 +124,12 @@ markdown_extensions:
   - pymdownx.emoji:
       emoji_index: !!python/name:material.extensions.emoji.twemoji
       emoji_generator: !!python/name:materialx.emoji.to_svg
+  - toc:
+      title: On this page
+      toc_depth: 3
+      permalink: true
+  - pymdownx.tabbed:
+      alternate_style: true
 
 copyright: |
   &copy; 2024 <a href="https://www.codium.ai/"  target="_blank" rel="noopener">CodiumAI</a>
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,4 @@
		# Generate tests for a Python Class


		Put a YouTube video here
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Open a PR with Codiumate

		Put a YouTube video here