Developer's guide overview

gufolabs · Jan 31, 2024 · 33c51be · 33c51be
1 parent 0c44b0d
commit 33c51be
Show file tree

Hide file tree

Showing 13 changed files with 26 additions and 11 deletions.
diff --git a/docs/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md
diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
diff --git a/docs/dev/CODE_OF_CONDUCT.md b/docs/dev/CODE_OF_CONDUCT.md
@@ -0,0 +1 @@
+../../CODE_OF_CONDUCT.md
diff --git a/docs/dev/CONTRIBUTING.md b/docs/dev/CONTRIBUTING.md
@@ -0,0 +1 @@
+../../CONTRIBUTING.md
diff --git a/docs/codebase.md → docs/dev/codebase.md b/docs/codebase.md → docs/dev/codebase.md
diff --git a/docs/codequality.md → docs/dev/codequality.md b/docs/codequality.md → docs/dev/codequality.md
diff --git a/docs/devcommon.md → docs/dev/common.md b/docs/devcommon.md → docs/dev/common.md
diff --git a/docs/environment.md → docs/dev/environment.md b/docs/environment.md → docs/dev/environment.md
diff --git a/docs/dev/index.md b/docs/dev/index.md
@@ -0,0 +1,14 @@
+# Gufo SNMP: Developer's Guide
+
+This section is intended for Gufo SNMP developers and for entities, 
+including both individuals and companies, interested in contributing to the project.
+
+- [Developer's Environment](environment.md)
+- [Building and Testing](testing.md)
+- [Common Tasks](common.md)
+- [Code Quality](codequality.md)
+- [Code Base](codebase.md)
+- [Contributing Guide](CONTRIBUTING.md)
+- [Code of Conduct](CODE_OF_CONDUCT.md)
+- [Supported Standards](standards.md)
+- [Supported BER Types](types.md)
diff --git a/docs/standards.md → docs/dev/standards.md b/docs/standards.md → docs/dev/standards.md
diff --git a/docs/testing.md → docs/dev/testing.md b/docs/testing.md → docs/dev/testing.md
diff --git a/docs/types.md → docs/dev/types.md b/docs/types.md → docs/dev/types.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -22,15 +22,16 @@ nav:
       - Debugging: examples/debugging.md
   - Reference: reference/
   - Developers' Guide:
-      - Developer's Environment: environment.md
-      - Building and Testing: testing.md
-      - Common Tasks: devcommon.md
-      - Code Quality: codequality.md
-      - Code Base: codebase.md
-      - Contributing Guide: CONTRIBUTING.md
-      - Code of Conduct: CODE_OF_CONDUCT.md
-      - Supported Standards: standards.md
-      - Supported BER Types: types.md
+      - Overview: dev/index.md
+      - Developer's Environment: dev/environment.md
+      - Building and Testing: dev/testing.md
+      - Common Tasks: dev/common.md
+      - Code Quality: dev/codequality.md
+      - Code Base: dev/codebase.md
+      - Contributing Guide: dev/CONTRIBUTING.md
+      - Code of Conduct: dev/CODE_OF_CONDUCT.md
+      - Supported Standards: dev/standards.md
+      - Supported BER Types: dev/types.md
   - Benchmarks: benchmarks.md
   - FAQ: faq.md
   - Changelog: CHANGELOG.md