diff --git a/README.md b/README.md index b1a759d..a522e98 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -![alt text](https://github.com/MrBounty/ZipponDB/blob/main/docs/images/banner.old.png) +![alt text](https://github.com/MrBounty/ZipponDB/blob/main/docs/images/banner.png) # Introduction diff --git a/docs/Single_file.md b/docs/Single_file.md new file mode 100644 index 0000000..8730105 --- /dev/null +++ b/docs/Single_file.md @@ -0,0 +1,15 @@ +# Single file + +TODO: In the future I will migrate into a single file database like SQLite. + +## FileVar + +A FileVar is a single value but saved in a file. This have a Blok, a position, a size and a type. +For string, I will create something different I think, with a size max and a len, and can request more if needed. + +## FileBlok + +A blok is like memory but for file. It has a starting point and a size and can hold entities or FileVar. +Everything I will save will be linked into a Blok and I can create and delete it at will. The size it given in the config and can't change. + +In SQLite, it is what they call a page I think. Similare thing. diff --git a/docs/Technical docs.md b/docs/Technical docs.md index 45d7d16..2f132c3 100644 --- a/docs/Technical docs.md +++ b/docs/Technical docs.md @@ -220,6 +220,10 @@ A condition have those infos: NewData is a map with member name as key and ConditionValue as value, it is created when parsing and is use to add data into a file. I transform ConditionValue into Zid Data. Maybe I can directly do a map member name -> zid Data ? +### RelationMap + +TODO: Explain. + ## EntityWriter This is responsable to transform the raw Data into a JSON, Table or other output format to send send to end user. diff --git a/docs/features.md b/docs/features.md new file mode 100644 index 0000000..eb3fbeb --- /dev/null +++ b/docs/features.md @@ -0,0 +1,3 @@ +# Features + +TODO diff --git a/docs/images/banner.old.png b/docs/images/banner.old.png deleted file mode 100644 index 761dbce..0000000 Binary files a/docs/images/banner.old.png and /dev/null differ diff --git a/docs/images/banner.png b/docs/images/banner.png index d67b8db..761dbce 100644 Binary files a/docs/images/banner.png and b/docs/images/banner.png differ diff --git a/docs/images/banner_white.png b/docs/images/banner_white.png deleted file mode 100644 index 18f76ae..0000000 Binary files a/docs/images/banner_white.png and /dev/null differ diff --git a/docs/release.md b/docs/release.md new file mode 100644 index 0000000..55ec507 --- /dev/null +++ b/docs/release.md @@ -0,0 +1,9 @@ +# Release + +## 0.1.8 + +First release. + +Mostly to test the release pipeline with Github actions. +Only include CLI, most ZiQL features here but still missing some part. +Mostly missing thing around the database to make it usable. diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css new file mode 100644 index 0000000..03fd9ed --- /dev/null +++ b/docs/stylesheets/extra.css @@ -0,0 +1,12 @@ +:root { + --md-primary-fg-color: #FEFADF; + --md-primary-fg-color--light: #FCFBF2; + --md-primary-fg-color--dark: #E3C797; + + --md-primary-bg-color: #000000; + --md-typeset-a-color: #000000; +} + +[data-md-color-scheme="default"] { + --md-typeset-a-color: #c57d00; +} \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index d429362..22eab28 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,3 +1,4 @@ +site_name: "Documentation" site_url: https://MrBounty.github.io/ZipponDB/ repo_url: https://github.com/MrBounty/ZipponDB theme: @@ -13,7 +14,8 @@ theme: palette: - media: "(prefers-color-scheme: light)" scheme: default - primary: lime + primary: custom + accent: amber toggle: icon: material/brightness-7 name: Switch to dark mode @@ -21,10 +23,12 @@ theme: # Palette toggle for dark mode - media: "(prefers-color-scheme: dark)" scheme: slate - primary: lime + primary: custom + accent: amber toggle: icon: material/brightness-4 name: Switch to light mode + markdown_extensions: - attr_list - md_in_html @@ -40,17 +44,22 @@ plugins: - glightbox - search +extra_css: + - stylesheets/extra.css + nav: - Home: index.md - - Using ZipponDB: + - Features: features.md + - Learn: - Quickstart: Quickstart.md - Schema: Schema.md - ZipponQL: ZiQL.md - Data types: Data type.md - Command Line Interface: cli.md - - Under the Hood: + - Technical: - Benchmark: Benchmark.md - Technical: Technical docs.md - ZipponData: ZipponData.md - - About: about.md - - Roadmap: Roadmap.md + - About: about.md + - Roadmap: Roadmap.md + - Release: release.md