Merge pull request #28 from mrjvs/dev

Guider v0.1.1

.github/ISSUE_TEMPLATE/1.bug_report.yml

@@ -0,0 +1,43 @@
+name: Bug Report
+description: Create a bug report
+labels: ["type:bug"]
+body:
+  - type: textarea
+    attributes:
+      label: Describe the bug
+      description: A concise description of the bug.
+    validations:
+      required: true
+  - type: dropdown
+    attributes:
+      label: Which package/app is affected (leave empty if unsure)
+      multiple: true
+      options:
+        - "@neato/guider"
+        - "@neato/config"
+        - "docs"
+        - "examples"
+  - type: input
+    attributes:
+      label: Link to the code that reproduces this issue
+      description: |
+        If possible, link to a minimal reproducable example. This can be a GitHub gist or a repository, choose whatever fits.
+  - type: textarea
+    attributes:
+      label: Steps to reproduce
+      description: Steps to reproduce the behavior, please provide a clear description of how to reproduce the issue, based on the linked minimal reproduction. Screenshots can be provided in the issue body below. If using code blocks, make sure that [syntax highlighting is correct](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks#syntax-highlighting) and double check that the rendered preview is not broken.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Expected Behavior
+      description: A clear and concise description of what you expected to happen.
+    validations:
+      required: true
+  - type: markdown
+    attributes:
+      value: Before submitting, please make sure that the reproduce steps you've provided are easy to follow.
+  - type: textarea
+    attributes:
+      label: Extra details
+      description: If you have extra information or a proposal on how to implement it, this is the place.

.github/ISSUE_TEMPLATE/2.feature_request.yml

@@ -0,0 +1,33 @@
+name: Feature request
+description: Request a feature
+labels: ["type:feature"]
+body:
+  - type: textarea
+    attributes:
+      label: What feature do you want?
+      description: A clear description of the new feature.
+    validations:
+      required: true
+  - type: dropdown
+    attributes:
+      label: Which package/app is this targeted at (leave empty if unsure)
+      multiple: true
+      options:
+        - "@neato/guider"
+        - "@neato/config"
+        - "docs"
+        - "examples"
+  - type: textarea
+    attributes:
+      label: Goals
+      description: Short list of goals what the feature request aims to address.
+      value: |
+        1.
+        2.
+        3.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Extra details
+      description: If you have extra information or a proposal on how to implement it, this is the place.

.github/ISSUE_TEMPLATE/3.other.yml

@@ -0,0 +1,18 @@
+name: Help or Miscellaneous
+description: Need help or some other inquiries
+labels: ["type:other"]
+body:
+  - type: textarea
+    attributes:
+      label: Your inquiry
+    validations:
+      required: true
+  - type: dropdown
+    attributes:
+      label: Which package/app is this targeted at (leave empty if unsure)
+      multiple: true
+      options:
+        - "@neato/guider"
+        - "@neato/config"
+        - "docs"
+        - "examples"

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

.gitignore

@@ -8,3 +8,4 @@ dist
 out
 /test.js
 /test.ts
+.turbo

README.md

@@ -5,13 +5,12 @@
 - isolated, use the packages on their own
 - no abstraction, you're using well-known libraries, almost no need for neato-specific google searches
 
-> [!WARNING]
-> This is not even near to complete, don't use it
-
 ## Packages
-- @neato/router - http router based on fastify
+- @neato/config - load configurations from various sources with type-safety and validation (BETA)
+- @neato/guider - beautiful documentation generator framework based on nextjs (ALPHA)
+
+## Upcoming packages
+- @neato/router - http router based on fastify ()
 - @neato/orm - mini ORM, it's just migrations, mapper and a query builder
 - @neato/email - JSX based email template engine
-- @neato/config - load configurations from various sources with type-safety and validation
 - @neato/auth - fully fledged authentication system, including permissions
-- @neato/guider - beautiful documentation generator framework based on nextjs

apps/docs/components/home-card.tsx

@@ -1,6 +1,6 @@
 import type { ReactNode } from 'react';
 import { Icon } from '@neato/guider/client';
-import Link from 'next/link';
+import Link from 'next/link.js';
 import styles from './home-card.module.css';
 
 function Card(props: {

apps/docs/components/logo.tsx

@@ -1,4 +1,4 @@
-import Link from 'next/link';
+import Link from 'next/link.js';
 import styles from './logo.module.css';
 
 export function Logo() {

apps/docs/next.config.js → apps/docs/next.config.mjs

@@ -1,9 +1,9 @@
-const { guider } = require('@neato/guider');
+import { guider } from '@neato/guider';
 
 const withGuider = guider({
   themeConfig: './theme.config.tsx',
 });
 
-module.exports = withGuider({
+export default withGuider({
   output: 'export',
 });