add edit page & link to rfc

nix-community · Sep 25, 2023 · 645eac8 · 645eac8
1 parent 7dba4b8
commit 645eac8
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 3 deletions.
diff --git a/nixpkgs-docs-example/astro.config.mjs b/nixpkgs-docs-example/astro.config.mjs
@@ -12,10 +12,19 @@ export default defineConfig({
         src: "./src/assets/nix-logo.svg",
       },
       tableOfContents: { minHeadingLevel: 1, maxHeadingLevel: 4 },
+
       social: {
-        github: "https://github.com/nixos/nixpkgs",
+        github: "https://github.com/hsjobeki/nix-doc-comments",
+      },
+      editLink: {
+        baseUrl:
+          "https://github.com/hsjobeki/nix-doc-comments/nixpkgs-docs-example/edit/main/docs/",
       },
       sidebar: [
+        {
+          label: "Home",
+          link: "/",
+        },
         {
           label: "Reference",
           autogenerate: { directory: "reference" },

diff --git a/nixpkgs-docs-example/src/content/docs/index.mdx b/nixpkgs-docs-example/src/content/docs/index.mdx
@@ -3,14 +3,25 @@ title: API Documentation for nix, nixpkgs and nixos
 description: Explore our documentation
 template: splash
 hero:
-  tagline: Nix is awesome!
+  tagline: Support RFC-145 - Because Automatic Documentation is awesome!
   image:
     file: ../../assets/nixoscolorful.svg
   actions:
     - text: To the docs
-      link: nix-doc-comments/reference/add
+      link: reference/add
       icon: right-arrow
       variant: primary
+    - text: To the RFC145
+      link: https://github.com/NixOS/rfcs/pull/145
+      icon: right-arrow
+      variant: secondary
+sidebar:
+  hidden: false
+  label: Home
+  order: 0
+banner:
+  content: |
+    Generate documentation for your nix project!
 ---
 
 import { LinkCard, CardGrid } from "@astrojs/starlight/components";