restructure

henriqueleite42 · Aug 21, 2024 · 59d6dec · 59d6dec
1 parent 2934681
commit 59d6dec
Show file tree

Hide file tree

Showing 33 changed files with 85 additions and 63 deletions.
diff --git a/.github/workflows/deploy-docs.yaml b/.github/workflows/deploy-docs.yaml
@@ -5,6 +5,8 @@ on:
   # Runs on pushes targeting the default branch
   push:
     branches: ["master"]
+    paths:
+      - docs/**
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:

diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -2,6 +2,9 @@
 	"files.associations": {
     "*.anv": "yaml",
   },
+	"files.exclude": {
+		"vendor/**": true,
+	},
 	"cSpell.words": [
 		"anvil",
 		"anvilconfig",

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
diff --git a/README.md b/README.md
@@ -1,5 +1,5 @@
 <div align="center">
-  <img src="./static/img/logo.webp" alt="anvil" width="500" height="500">
+  <img src="./docs/static/img/logo.webp" alt="anvil" width="500" height="500">
 <div>
 
 # Anvil
@@ -70,47 +70,12 @@ Anvil plugins:
 
 ## F.A.Q.
 
-[See the F.A.Q. here.](./FAQ.md)
+[See the F.A.Q. here.](https://henriqueleite42.github.io/anvil/docs/faq)
 
 ## Examples
 
-[See the examples here.](./examples.md)
+[See the examples here.](https://github.com/henriqueleite42/anvil/tree/master/examples)
 
-## How Anvil work
+## How it works
 
-Anvil has 5 main parts, each one responsible for a specific complementary role.
-
-### `*.anv` files
-
-The schema definition is a `.anv` file that describes a domain of your service. Each project (micro-service) can have multiple domains in it, and they can be related or not (ideally, if they are in the same project, they should be).
-
-Think about the `.anv` files like a `schema.prisma` or an OpenApi spec, and from this we generate an infinity of things.
-
-### `.anvilconfig`
-
-`.anvilconfig` is the configuration file for Anvil, where you put information like the plugins that you are using, the things that you want to generate, and any other configuration that Anvil CLI or the plugins may need.
-
-It is written in [TOML](https://toml.io/en/).
-
-### CLI
-
-The CLI is the way that you interact with all Anvil things. You can use it to validate your files, generate things, install plugins, run your migrations, and much more.
-
-It's designed to work with CI/CD too 🙌
-
-### Generators
-
-Generators allows you to generate code based on a `.anv` config. They come in various shapes and sizes, and can be used for practically anything:
-- Generate an microservice with a specific code pattern, that uses a specific set of libraries
-- Generate e2e tests
-- Generate changelogs
-
-Generator are were the magic oh Anvil happens.
-
-### Plugins
-
-Plugins do side-effects with Anvil, like:
-- Create tasks in Jira based on the changes of the schema.
-- Notify breaking changes to dependent projects
-
-Very useful for Agile environments.
+[Understand how it works here.](https://henriqueleite42.github.io/anvil/docs/how-it-works)
diff --git a/cmd/build.go → cli/cmd/build.go b/cmd/build.go → cli/cmd/build.go
diff --git a/cmd/config/config.go → cli/cmd/config/config.go b/cmd/config/config.go → cli/cmd/config/config.go
diff --git a/cmd/index.go → cli/cmd/index.go b/cmd/index.go → cli/cmd/index.go
diff --git a/cmd/parse.go → cli/cmd/parse.go b/cmd/parse.go → cli/cmd/parse.go
diff --git a/cmd/version.go → cli/cmd/version.go b/cmd/version.go → cli/cmd/version.go
diff --git a/go.mod → cli/go.mod b/go.mod → cli/go.mod
diff --git a/go.sum → cli/go.sum b/go.sum → cli/go.sum
diff --git a/internal/hashing/string.go → cli/internal/hashing/string.go b/internal/hashing/string.go → cli/internal/hashing/string.go
diff --git a/internal/hashing/struct.go → cli/internal/hashing/struct.go b/internal/hashing/struct.go → cli/internal/hashing/struct.go
diff --git a/internal/parser/auth.go → cli/internal/parser/auth.go b/internal/parser/auth.go → cli/internal/parser/auth.go
diff --git a/internal/parser/domain.go → cli/internal/parser/domain.go b/internal/parser/domain.go → cli/internal/parser/domain.go
diff --git a/internal/parser/enums.go → cli/internal/parser/enums.go b/internal/parser/enums.go → cli/internal/parser/enums.go
diff --git a/internal/parser/imports.go → cli/internal/parser/imports.go b/internal/parser/imports.go → cli/internal/parser/imports.go
diff --git a/internal/parser/metadata.go → cli/internal/parser/metadata.go b/internal/parser/metadata.go → cli/internal/parser/metadata.go
diff --git a/internal/parser/parser.go → cli/internal/parser/parser.go b/internal/parser/parser.go → cli/internal/parser/parser.go
diff --git a/internal/parser/relationships.go → cli/internal/parser/relationships.go b/internal/parser/relationships.go → cli/internal/parser/relationships.go
diff --git a/internal/parser/utils.go → cli/internal/parser/utils.go b/internal/parser/utils.go → cli/internal/parser/utils.go
diff --git a/internal/schema/schema.go → cli/internal/schema/schema.go b/internal/schema/schema.go → cli/internal/schema/schema.go
diff --git a/main.go → cli/main.go b/main.go → cli/main.go
diff --git a/tests/main.go → cli/tests/main.go b/tests/main.go → cli/tests/main.go
diff --git a/tests/parser/authentication.go → cli/tests/parser/authentication.go b/tests/parser/authentication.go → cli/tests/parser/authentication.go
@@ -11,7 +11,7 @@ import (
 )
 
 func Authentication() {
-	fileData, err := os.ReadFile("./examples/advanced/authentication.anv")
+	fileData, err := os.ReadFile("../examples/advanced/authentication.anv")
 	if err != nil {
 		log.Fatal(err)
 	}

diff --git a/FAQ.md → docs/docs/faq.md b/FAQ.md → docs/docs/faq.md
@@ -1,3 +1,7 @@
+---
+sidebar_position: 2
+---
+
 # F.A.Q.
 
 ## Is Anvil ready to use right out the box?

diff --git a/docs/docs/generators/_category_.json b/docs/docs/generators/_category_.json
@@ -1,8 +1,8 @@
 {
-  "label": "Generators",
-  "position": 4,
-  "link": {
-    "type": "generated-index",
-    "description": "How to develop generators"
-  }
-}
+	"label": "Generators",
+	"position": 20,
+	"link": {
+		"type": "generated-index",
+		"description": "How to develop generators"
+	}
+}
diff --git a/docs/docs/how-it-works.md b/docs/docs/how-it-works.md
@@ -0,0 +1,42 @@
+---
+sidebar_position: 3
+---
+
+## How it work
+
+Anvil has 5 main parts, each one responsible for a specific complementary role.
+
+### `*.anv` files
+
+The schema definition is a `.anv` file that describes a domain of your service. Each project (micro-service) can have multiple domains in it, and they can be related or not (ideally, if they are in the same project, they should be).
+
+Think about the `.anv` files like a `schema.prisma` or an OpenApi spec, and from this we generate an infinity of things.
+
+### `.anvilconfig`
+
+`.anvilconfig` is the configuration file for Anvil, where you put information like the plugins that you are using, the things that you want to generate, and any other configuration that Anvil CLI or the plugins may need.
+
+It is written in [TOML](https://toml.io/en/).
+
+### CLI
+
+The CLI is the way that you interact with all Anvil things. You can use it to validate your files, generate things, install plugins, run your migrations, and much more.
+
+It's designed to work with CI/CD too 🙌
+
+### Generators
+
+Generators allows you to generate code based on a `.anv` config. They come in various shapes and sizes, and can be used for practically anything:
+- Generate an microservice with a specific code pattern, that uses a specific set of libraries
+- Generate e2e tests
+- Generate changelogs
+
+Generator are were the magic oh Anvil happens.
+
+### Plugins
+
+Plugins do side-effects with Anvil, like:
+- Create tasks in Jira based on the changes of the schema.
+- Notify breaking changes to dependent projects
+
+Very useful for Agile environments.
diff --git a/docs/docs/intro.md → docs/docs/introduction.md b/docs/docs/intro.md → docs/docs/introduction.md
@@ -1,7 +1,8 @@
 ---
 sidebar_position: 1
 ---
-# Anvil
+
+# Introduction
 
 Anvil is like OpenAPI schemas for microservices, but instead of only documenting your http routes, it helps you to manage most of the aspects of all your microservices at a global scale. It's created to medium~big companies and suffer on delivering things with velocity and consistency.
 

diff --git a/docs/docs/plugins/_category_.json b/docs/docs/plugins/_category_.json
@@ -1,8 +1,8 @@
 {
-  "label": "Plugins",
-  "position": 3,
-  "link": {
-    "type": "generated-index",
-    "description": "How to develop plugins"
-  }
-}
+	"label": "Plugins",
+	"position": 30,
+	"link": {
+		"type": "generated-index",
+		"description": "How to develop plugins"
+	}
+}
diff --git a/ROADMAP.md → docs/docs/roadmap.md b/ROADMAP.md → docs/docs/roadmap.md
@@ -1,3 +1,7 @@
+---
+sidebar_position: 4
+---
+
 # Roadmap
 
 ## Critical features

diff --git a/TECHNICAL-DECISIONS.md → docs/docs/tech-decisions.md b/TECHNICAL-DECISIONS.md → docs/docs/tech-decisions.md
@@ -1,4 +1,10 @@
-# Our Technical Decisions and how we took them
+---
+sidebar_position: 9
+---
+
+# Technical Decisions
+
+See our technical decisions and why we took them.
 
 ### Why is Anvil written in Golang?
 

diff --git a/docs/docs/use/schema.md b/docs/docs/use/schema.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 2
+sidebar_position: 10
 ---
 
 # Schema