docs: add mkdocs, update links, add architecture documentation
This commit is contained in:
37
docs/content/adr/0001-go-module-path.md
Normal file
37
docs/content/adr/0001-go-module-path.md
Normal file
@@ -0,0 +1,37 @@
|
||||
# ADR-0001: Go Module Path
|
||||
|
||||
## Status
|
||||
Accepted
|
||||
|
||||
## Context
|
||||
The project needs a Go module path that uniquely identifies the platform. This path will be used:
|
||||
- In `go.mod` file
|
||||
- For importing packages within the project
|
||||
- For module dependencies
|
||||
- For future module publishing
|
||||
|
||||
## Decision
|
||||
Use `git.dcentral.systems/toolz/goplt` as the Go module path.
|
||||
|
||||
**Rationale:**
|
||||
- Matches the organization's Git hosting structure
|
||||
- Follows Go module naming conventions
|
||||
- Clearly identifies the project as a Go platform tool
|
||||
- Prevents naming conflicts with other modules
|
||||
|
||||
## Consequences
|
||||
|
||||
### Positive
|
||||
- Clear, descriptive module path
|
||||
- Aligns with organization's infrastructure
|
||||
- Easy to identify in dependency graphs
|
||||
|
||||
### Negative
|
||||
- Requires access to `git.dcentral.systems` for module resolution
|
||||
- May need to configure GOPRIVATE/GONOPROXY if using private registry
|
||||
|
||||
### Implementation Notes
|
||||
- Initialize module: `go mod init git.dcentral.systems/toolz/goplt`
|
||||
- Update all import paths in code to use this module path
|
||||
- Configure `.git/config` or Go environment variables if needed for private module access
|
||||
|
||||
Reference in New Issue
Block a user