Feat/1/setup (#3)

* [#1] Added initial project structure

* [#1] added hextra library, homepage and git workflow

* [#1] Updated Readme

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,73 @@
+## Code of Conduct - golly-docs
+
+### Introduction
+
+We are committed to creating a welcoming and inclusive environment for everyone
+who participates in our golly-docs open-source project, regardless of their
+background, identity, or experience. We expect all contributors, maintainers,
+and users to adhere to the following code of conduct to ensure a positive and
+respectful community.
+
+### Our Pledge
+
+In order to create an open and inclusive space, we pledge to:
+
+1. Foster a welcoming and harassment-free environment where all individuals can
+   freely express their opinions, ideas, and experiences.
+2. Respect and value diverse perspectives, backgrounds, and experiences, and
+   avoid any form of discrimination or exclusion.
+3. Encourage constructive and respectful discussions that focus on technical
+   aspects and project-related topics.
+4. Be patient and understanding towards others, especially those who are new to
+   the project or have different levels of expertise.
+5. Address conflicts and disagreements constructively, seeking resolution
+   through open communication and collaboration.
+6. Be accountable for our actions and words, and acknowledge and learn from any
+   mistakes we make.
+7. Protect the privacy and confidentiality of individuals and their personal
+   information.
+
+### Expected Behavior
+
+All individuals involved in the project, including but not limited to
+contributors, maintainers, and users, are expected to:
+
+1. Be respectful and inclusive, irrespective of differences such as gender,
+   sexual orientation, race, ethnicity, religion, or disability.
+2. Use welcoming and inclusive language, avoiding derogatory, offensive, or
+   discriminatory comments or jokes.
+3. Listen attentively, consider different perspectives, and avoid personal
+   attacks or inflammatory behavior.
+4. Provide constructive feedback and suggestions while maintaining a focus on
+   improving the project.
+5. Be open to learning from others and sharing knowledge in a supportive manner.
+6. Respect the decisions made by project maintainers and administrators,
+   understanding that they have the final authority on the project's direction
+   and policies.
+7. Report any violations of this code of conduct to the project maintainers via
+   the designated communication channels.
+
+### Unacceptable Behavior
+
+The following behaviors are considered unacceptable within our project
+community:
+
+1. Harassment, bullying, or intimidation in any form, including but not limited
+   to offensive comments, insults, or personal attacks.
+2. Discrimination, exclusion, or any other action that promotes a hostile or
+   unwelcome environment.
+3. Publishing or sharing others' private information without their consent.
+4. Deliberate disruption of discussions or the project's progress.
+5. Engaging in or promoting any form of offensive, discriminatory, or
+   inappropriate material or language.
+6. Any behavior that violates applicable laws or regulations.
+
+### Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project maintainers at
+[conduct-oss@nandlabs.io](mailto:conduct-oss@nandlabs.io). All complaints will
+be reviewed and investigated promptly and fairly. The maintainers are
+responsible for determining the appropriate actions to be taken, which may
+include warnings, temporary or permanent bans, or other measures deemed
+necessary.

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,28 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[BUG]"
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Execute the snippet
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Go Version (please complete the following information):**
+ - Version [e.g. 0.0.13]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/docs_report.md

@@ -0,0 +1,29 @@
+---
+name: Documentation
+about: Create an issue for documentation improvements
+title: "[Docs]"
+labels: documentation
+assignees: ""
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+
+1. Execute the snippet
+2. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Go Version (please complete the following information):**
+
+- Version [e.g. 0.0.13]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Provide the new feature requests for the project
+title: "[FEATURE]"
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,25 @@
+**IMPORTANT: Please do not create a Pull Request without creating/linking an issue first.**
+
+*Any change needs to be discussed before proceeding. Failure to do so may result in the rejection of the pull request.*
+
+Please provide enough information so that others can review your pull request:
+
+<!-- You can skip this if you're fixing a typo or adding an app to the Showcase. -->
+
+Explain the **details** for making this change. What existing problem does the pull request solve?
+
+<!-- Example: When "Adding a function to do X", explain why it is necessary to have a way to do X. -->
+
+**Test plan (required)**
+
+Demonstrate the code is solid. Example: The exact commands you ran and their output, screenshots / videos if the pull request changes UI.
+
+<!-- Make sure tests pass on both Travis and Circle CI. -->
+
+**Code formatting**
+
+<!-- See the simple style guide. -->
+
+**Closing issues**
+
+Put `closes #XXXX` in your comment to auto-close the issue that your PR fixes (if such).

.github/workflows/pages.yaml

@@ -0,0 +1,76 @@
+# Sample workflow for building and deploying a Hugo site to GitHub Pages
+name: Deploy Hugo site to Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["main"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+# Default to bash
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    env:
+      HUGO_VERSION: 0.126.3
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # fetch all history for .GitInfo and .Lastmod
+          submodules: recursive
+      - name: Setup Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: "1.22"
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v4
+      - name: Setup Hugo
+        run: |
+          wget -O ${{ runner.temp }}/hugo.deb https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb \
+          && sudo dpkg -i ${{ runner.temp }}/hugo.deb
+      - name: Build with Hugo
+        env:
+          # For maximum backward compatibility with Hugo modules
+          HUGO_ENVIRONMENT: production
+          HUGO_ENV: production
+        run: |
+          hugo \
+            --gc --minify \
+            --baseURL "${{ steps.pages.outputs.base_url }}/"
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./public
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -0,0 +1,3 @@
+.vscode
+.hugo_build.lock
+public/

README.md

@@ -0,0 +1,14 @@
+# golly-docs
+
+This repository is for the documentation of the [Golly project](https://github.com/nandlabs/golly).
+
+## Contributing
+
+We welcome contributions to the project. If you find a bug or would like to
+request a new feature, please open an issue on
+[GitHub](https://github.com/nandlabs/golly-docs/issues).
+
+## License
+
+This project is licensed under MIT License. See the [License](LICENSE) file for
+details.

SECURITY.md

@@ -0,0 +1,12 @@
+# Security Policy
+
+## Reporting a Vulnerability
+
+If you find any vulnerability in our code or the API we are running, please
+contact us ASAP by creating an
+[Issue](https://github.com/nandlabs/golly-docs/issues/new/choose). We do take
+this very seriously.
+
+We will respond to you as fast as we can and start working to fix the problem.
+Please also keep in mind and understand that this is an open-source project and
+that the maintainers also have other work to finish.

content/_index.md

@@ -0,0 +1,81 @@
+---
+title: Hextra Theme
+layout: hextra-home
+---
+
+{{< hextra/hero-badge >}}
+
+  <div class="hx-w-2 hx-h-2 hx-rounded-full hx-bg-primary-400"></div>
+  <span>Free, open source</span>
+  {{< icon name="arrow-circle-right" attributes="height=14" >}}
+{{< /hextra/hero-badge >}}
+
+<div class="hx-mt-6 hx-mb-6">
+{{< hextra/hero-headline >}}
+  Build Enterprise Grade Applications in Go&nbsp;<br class="sm:hx-block hx-hidden" /> with minimal depenedencies
+{{< /hextra/hero-headline >}}
+</div>
+
+<div class="hx-mb-12">
+{{< hextra/hero-subtitle >}}
+  Robust, One Stop library for building go applications
+{{< /hextra/hero-subtitle >}}
+</div>
+
+<div class="hx-mb-6">
+{{< hextra/hero-button text="Get Started" link="docs" >}}
+</div>
+
+<div class="hx-mt-6"></div>
+
+{{< hextra/feature-grid >}}
+
+{{< hextra/feature-card
+
+    title="Codec"
+    subtitle="Codec offers an easy-to-use interface with multi-format support, providing a unified approach for encoding and decoding data in structured formats, with built-in support for XML, JSON, and YAML." >}}
+
+{{< hextra/feature-card
+
+    title="Turbo"
+    subtitle="Turbo is a user-friendly Go web framework designed for API development, featuring smart HTTP routing and flexible filter capabilities."
+    >}}
+
+{{< hextra/feature-card
+
+    title="Rest Client"
+    subtitle="Rest Client provides full HTTP method support (GET, POST, PUT, DELETE) along with query parameters, request headers, and configurable proxy, TLS, transport layer, and SSL settings. It also incorporates QoS features such as circuit breaker and retry handler for enhanced reliability and resilience, along with robust error handling."
+    >}}
+
+{{< hextra/feature-card
+
+    title="l3 (Lightweight Levelled Logger)"
+    subtitle="l3 provides versatile logging with multiple levels (OFF, ERROR, INFO, DEBUG, TRACE), supports both console and file-based writers, allows package-specific log level configurations, and offers async logging. Configuration can be managed through files, environment variables, or struct values at runtime."
+    >}}
+
+{{< hextra/feature-card
+
+    title="Messaging"
+    subtitle="Messaging offers a versatile producer interface for sending messages to various platforms, a consumer interface for receiving and processing messages, and a local provider interface for channel-based messaging. It is highly extensible, supporting providers such as AMQP, MQTT, Kafka, AWS, GCP, and Azure offerings."
+    >}}
+
+{{< hextra/feature-card
+
+    title="VFS (Virtual File System)"
+    subtitle="VFS  provides seamless integration with multiple file systems, including local storage, AWS S3, GCP Cloud Storage, Azure Cloud Storage, and more. It offers a unified interface for managing files across diverse storage solutions, simplifying file operations regardless of the underlying system."
+    >}}
+
+{{< hextra/feature-card
+
+    title="Cli"
+    subtitle="CLI offers an intuitive API for creating command-line applications, enabling the development of complex command structures with ease. It includes robust argument parsing and validation to ensure accurate and user-friendly command execution."
+    >}}
+
+{{< hextra/feature-card
+
+    title="And Much More..."
+    icon="sparkles"
+    subtitle="Semver / Testing / Config / Error Utils / IO Utils / UUID and more..."
+    >}}
+
+{{< /hextra/feature-grid >}}

go.mod

@@ -0,0 +1,5 @@
+module oss.nandlabs.io/golly-docs
+
+go 1.21
+
+require github.com/imfing/hextra v0.8.0 // indirect

go.sum

@@ -0,0 +1,2 @@
+github.com/imfing/hextra v0.8.0 h1:bG2GavmsMAgRRCrm+N4c+m6mBm9KYrgGH0mgaJpIXjM=
+github.com/imfing/hextra v0.8.0/go.mod h1:cEfel3lU/bSx7lTE/+uuR4GJaphyOyiwNR3PTqFTXpI=