diff --git a/docs/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md deleted file mode 120000 index 0400d57..0000000 --- a/docs/CODE_OF_CONDUCT.md +++ /dev/null @@ -1 +0,0 @@ -../CODE_OF_CONDUCT.md \ No newline at end of file diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md deleted file mode 120000 index 44fcc63..0000000 --- a/docs/CONTRIBUTING.md +++ /dev/null @@ -1 +0,0 @@ -../CONTRIBUTING.md \ No newline at end of file diff --git a/docs/dev/CODE_OF_CONDUCT.md b/docs/dev/CODE_OF_CONDUCT.md new file mode 120000 index 0000000..a3613c9 --- /dev/null +++ b/docs/dev/CODE_OF_CONDUCT.md @@ -0,0 +1 @@ +../../CODE_OF_CONDUCT.md \ No newline at end of file diff --git a/docs/dev/CONTRIBUTING.md b/docs/dev/CONTRIBUTING.md new file mode 120000 index 0000000..f939e75 --- /dev/null +++ b/docs/dev/CONTRIBUTING.md @@ -0,0 +1 @@ +../../CONTRIBUTING.md \ No newline at end of file diff --git a/docs/codebase.md b/docs/dev/codebase.md similarity index 100% rename from docs/codebase.md rename to docs/dev/codebase.md diff --git a/docs/codequality.md b/docs/dev/codequality.md similarity index 100% rename from docs/codequality.md rename to docs/dev/codequality.md diff --git a/docs/devcommon.md b/docs/dev/common.md similarity index 100% rename from docs/devcommon.md rename to docs/dev/common.md diff --git a/docs/environment.md b/docs/dev/environment.md similarity index 100% rename from docs/environment.md rename to docs/dev/environment.md diff --git a/docs/dev/index.md b/docs/dev/index.md new file mode 100644 index 0000000..5e0f0f7 --- /dev/null +++ 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 b/docs/dev/standards.md similarity index 100% rename from docs/standards.md rename to docs/dev/standards.md diff --git a/docs/testing.md b/docs/dev/testing.md similarity index 100% rename from docs/testing.md rename to docs/dev/testing.md diff --git a/docs/types.md b/docs/dev/types.md similarity index 100% rename from docs/types.md rename to docs/dev/types.md diff --git a/mkdocs.yml b/mkdocs.yml index 28a2d03..7daded6 100644 --- 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