docs: some more pages

LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Galadrim
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

app/adomin/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Galadrim
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

docs/content/_index.md

@@ -5,14 +5,33 @@ type: docs
 
 # Introduction
 
-Adomin is a starting point for creating a custom backoffice for your Adonis application it is composed of:
+{{< br >}}
 
-- backend files that will be imported on your adonis backend
+Adomin is a starting point for creating a custom backoffice for your Adonis application.
+
+It is composed of two main parts:
+
+- backend files that will be copied on your adonis backend
 - a react/vite frontend repository to clone
 
-Adomin is for grown up people that are ready to **OWN** the code that they will download.
-If you want a software with easy update, Adomin is **NOT** for you.
-Adomin is meant to be used as a base for a quick and solid backoffice with the ability to add infinite customisations (you own the code)
+{{< br >}}
+
+Adomin is **NOT** a library. It's a backoffice system that you can copy and paste into your Adonis apps.
+
+You can think of it like **Shadcn** but for Adonis backoffice.
+
+{{< br >}}
+
+Adomin is for developers that are ready to **OWN** the code that they will download.
+
+It is meant to be used as a base for a quick and solid backoffice with the ability to add infinite customisations.
+
+We won't be able to provide support for every bug or new feature that you might want.
+
+That said, do not hesitate to post your issues [here](https://github.com/galadrimteam/adomin/issues)
+
+{{< br >}}
 
 Without style changes, it looks like this:
+
 ![Adomin frontend](/adomin/images/frontend.png)

docs/content/docs/installation/_index.md

@@ -17,3 +17,8 @@ Then you will have to install a few packages :
 ```bash
 yarn add xlsx @adonisjs/validator
 ```
+
+Adomin use imports starting with `#adomin` so you will have to configure this:
+
+- edit `package.json` and add `"#adomin/_": "./app/adomin/_.js"` inside the `"imports"` object
+- edit `tsconfig.json` and add `"#adomin/_": ["./app/adomin/_.js"]` inside the `"paths"` object

docs/hugo.toml

@@ -7,3 +7,8 @@ theme = 'hugo-book'
   # (Optional, default light) Sets color theme: light, dark or auto.
   # Theme 'auto' switches between dark and light modes based on browser/os preferences
   BookTheme = 'auto'
+[menu]
+[[menu.after]]
+  name = "Github"
+  url = "https://github.com/galadrimteam/adomin"
+  weight = 1000

docs/themes/hugo-book/layouts/partials/docs/html-head.html

@@ -15,7 +15,8 @@
 
 {{- $manifest := resources.Get "manifest.json" | resources.ExecuteAsTemplate "manifest.json" . }}
 <link rel="manifest" href="{{ $manifest.RelPermalink }}">
-<link rel="icon" href="{{ .Site.Params.BookFavicon | default "favicon.png" | relURL }}" >
+<link rel="icon" href="https://galadrim.fr/img/favicon.png" >
+<!-- <link rel="icon" href="{{ .Site.Params.BookFavicon | default "favicon.png" | relURL }}" > -->
 <link rel="canonical" href="{{ .Permalink }}">
 
 {{- range .Translations }}

docs/themes/hugo-book/layouts/partials/docs/inject/footer.html

@@ -0,0 +1,34 @@
+<br />
+<br />
+
+<style>
+  #galadrim-footer {
+    position: fixed;
+    bottom: 0px;
+    text-align: center;
+    font-size: large;
+    width: 100%;
+  }
+
+  .footer-link {
+    text-decoration: underline;
+    color: #0081ff;
+    text-underline-offset: 4px;
+  }
+</style>
+
+<div id="galadrim-footer">
+  <p>
+    Built by
+    <a href="https://galadrim.fr" target="_blank" rel="noreferrer" class="footer-link">Galadrim</a>.
+  </p>
+</div>
+
+<script>
+  const galadrimFooter = document.getElementById('galadrim-footer')
+  // remove from dom
+  galadrimFooter.remove()
+
+  // append to body
+  document.body.appendChild(galadrimFooter)
+</script>

docs/themes/hugo-book/layouts/partials/docs/inject/menu-before.html

@@ -0,0 +1,5 @@
+<ul>
+  <li>
+    <a href="/adomin/"> Introduction </a>
+  </li>
+</ul>

docs/themes/hugo-book/layouts/shortcodes/br.html

@@ -0,0 +1 @@
+<br />