Skip to content

Commit 4d540fa

Browse files
docs: update architecture documentation and enhance license details
- Revise architecture overview to include a complete worked example and clarify module responsibilities. - Remove outdated development and features documentation. - Expand license section with detailed terms and conditions under the Apache License 2.0. - Update mkdocs navigation to reflect the removal of obsolete documents.
1 parent 8b8ecd8 commit 4d540fa

8 files changed

Lines changed: 724 additions & 916 deletions

File tree

docs/api_reference/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,5 +105,5 @@ See the [Changelog](../changelog.md) for version history and breaking changes.
105105
For information about contributing to ArchiPy's development, please see:
106106

107107
- [Contributing Guide](../contributing.md)
108-
- [Development Guide](../development.md)
108+
- [Development Guide](../contributing.md)
109109
- [Documentation Guide](../contributing-docs.md)

docs/architecture.md

Lines changed: 676 additions & 523 deletions
Large diffs are not rendered by default.

docs/development.md

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

docs/examples/adapters/scylladb.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -820,7 +820,7 @@ logger.info(f"Health: {health['status']}, Latency: {health['latency_ms']:.2f}ms"
820820

821821
- [ScyllaDB Documentation](https://docs.scylladb.com/)
822822
- [Cassandra Query Language (CQL)](https://cassandra.apache.org/doc/latest/cql/)
823-
- [ArchiPy Configuration Guide](../../usage.md)
823+
- [ArchiPy Configuration Guide](../../examples/config_management.md)
824824

825825
## See Also
826826

docs/features.md

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

docs/license.md

Lines changed: 46 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,53 @@
11
---
22
title: License
3-
description: ArchiPy license information.
3+
description: ArchiPy is distributed under the Apache License 2.0.
44
---
55

66
# License
77

8-
ArchiPy is licensed under the terms of the license file included in the repository.
8+
ArchiPy is distributed under the **Apache License, Version 2.0**.
99

10-
For more details, see the [LICENSE](https://github.com/SyntaxArc/ArchiPy/blob/master/LICENSE) file.
10+
Copyright 2024 [SyntaxArc](https://github.com/SyntaxArc) — Hossein Nejati & Mehdi Einali.
11+
12+
## What This Means for You
13+
14+
| You can... | Conditions |
15+
|-------------------------------------------------------------------|----------------------------------------------------------------------------|
16+
| Use ArchiPy freely in personal, academic, and commercial projects | Include the license and copyright notice |
17+
| Modify the source code and distribute your changes | State the changes you made |
18+
| Sublicense and distribute under a different license | Preserve all existing copyright, patent, and attribution notices |
19+
| Use patents contributed by contributors royalty-free | Patent rights terminate if you bring patent litigation against the project |
20+
21+
!!! note "Trademark Restriction"
22+
The Apache 2.0 license does **not** grant permission to use the SyntaxArc trade names, trademarks, or service marks,
23+
except as required for customary description of the software's origin.
24+
25+
## Full License Text
26+
27+
```
28+
Apache License
29+
Version 2.0, January 2004
30+
http://www.apache.org/licenses/
31+
32+
Copyright 2024 SyntaxArc (Hossein Nejati, Mehdi Einali)
33+
34+
Licensed under the Apache License, Version 2.0 (the "License");
35+
you may not use this file except in compliance with the License.
36+
You may obtain a copy of the License at
37+
38+
http://www.apache.org/licenses/LICENSE-2.0
39+
40+
Unless required by applicable law or agreed to in writing, software
41+
distributed under the License is distributed on an "AS IS" BASIS,
42+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
43+
implied. See the License for the specific language governing
44+
permissions and limitations under the License.
45+
```
46+
47+
For the complete license text, see the [LICENSE](https://github.com/SyntaxArc/ArchiPy/blob/master/LICENSE) file in the
48+
repository.
49+
50+
## See Also
51+
52+
- [Contributing Guide](contributing.md)
53+
- [Code of Conduct](https://github.com/SyntaxArc/ArchiPy/blob/master/CODE_OF_CONDUCT.md)

docs/mkdocs.yml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -122,9 +122,6 @@ plugins:
122122
nav:
123123
- Home: index.md
124124
- Installation: installation.md
125-
- Features: features.md
126-
- Getting Started: usage.md
127-
- Development: development.md
128125
- API Reference:
129126
- Overview: api_reference/index.md
130127
- Adapters:

0 commit comments

Comments
 (0)