Skip to content

Commit 0e6a847

Browse files
authored
feat: ✨ add wiki/fern docs setup (#180)
Signed-off-by: Newton <5769156+iamnewton@users.noreply.github.com>
1 parent 71694bd commit 0e6a847

7 files changed

Lines changed: 113 additions & 2 deletions

File tree

.github/workflows/wiki.yml

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# AUTO-GENERATED — do not edit directly.
2+
# Source: theholocron/holocron · packages/cli/src/commands/setup-workflows.ts
3+
# Tool: holocron sync-github
4+
# Changes: edit source in theholocron/holocron and push to alpha or main.
5+
name: Wiki
6+
7+
on: # yamllint disable-line rule:truthy
8+
push:
9+
branches: [main]
10+
pull_request:
11+
branches: [main]
12+
13+
concurrency:
14+
group: ${{ github.event_name == 'pull_request' && format('wiki-preview-{0}', github.event.pull_request.number) || 'wiki' }}
15+
cancel-in-progress: ${{ github.event_name == 'pull_request' }}
16+
17+
permissions:
18+
contents: read
19+
deployments: write
20+
21+
jobs:
22+
publish:
23+
name: Publish
24+
if: ${{ github.event_name != 'pull_request' }}
25+
uses: theholocron/.github/.github/workflows/wiki.yml@main
26+
secrets: inherit
27+
28+
preview:
29+
name: Preview
30+
if: ${{ github.event_name == 'pull_request' }}
31+
uses: theholocron/.github/.github/workflows/wiki.yml@main
32+
with:
33+
preview: true
34+
preview-id: pr-${{ github.event.pull_request.number }}
35+
fern-org: holocron
36+
base-path: node-template
37+
secrets: inherit

docs/wiki/decisions/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Decisions
2+
3+
Architectural Decision Records live here. Each file captures one architectural
4+
decision, the options that were considered, and the rationale for the choice made.
5+
6+
## Index
7+
8+
| ID | Title | Status |
9+
| --- | ----- | ------ |

docs/wiki/specifications/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Specifications
2+
3+
Accepted specs for planned or in-progress features.

docs/wiki/standards/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Standards
2+
3+
Engineering standards — conventions, practices, and guidelines that apply to this template.

fern/docs.yml

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# yaml-language-server: $schema=https://schema.buildwithfern.dev/docs-yml.json
2+
3+
instances:
4+
- url: holocron.docs.buildwithfern.com/node-template
5+
custom-domain: wiki.theholocron.dev/node-template
6+
multi-source: true
7+
8+
title: node-template Engineering
9+
10+
layout:
11+
page-width: full
12+
tabs-placement: header
13+
searchbar-placement: header
14+
15+
tabs:
16+
decisions:
17+
display-name: Decisions
18+
icon: fa-duotone fa-scale-balanced
19+
standards:
20+
display-name: Standards
21+
icon: fa-duotone fa-book
22+
specifications:
23+
display-name: Specifications
24+
icon: fa-duotone fa-file-lines
25+
26+
navigation:
27+
- tab: decisions
28+
layout:
29+
- section: Architecture Decision Records
30+
contents:
31+
- page: Index
32+
path: ../docs/wiki/decisions/README.md
33+
- tab: standards
34+
layout:
35+
- section: Standards
36+
contents:
37+
- page: Overview
38+
path: ../docs/wiki/standards/README.md
39+
- tab: specifications
40+
layout:
41+
- section: Specifications
42+
contents:
43+
- page: Overview
44+
path: ../docs/wiki/specifications/README.md
45+
46+
colors:
47+
accent-primary:
48+
dark: "#70E155"
49+
light: "#008700"
50+
51+
logo:
52+
height: 20
53+
54+
metadata:
55+
og:dynamic: true

fern/fern.config.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"organization": "holocron",
3+
"version": "5.35.4"
4+
}

holocron.config.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import { defineConfig } from "@theholocron/cli";
2-
import { nodeDocs } from "@theholocron/holocron-config";
2+
import { compose, nodeDocs, wikiCapability as wiki } from "@theholocron/holocron-config";
33

4-
const { repo, workflows, providers, org, domain, docs } = nodeDocs();
4+
const { repo, workflows, providers, org, domain, docs } = compose(nodeDocs(), wiki());
55
export default defineConfig({
66
description:
77
"A modern NodeJS template with pre-configured tools, best practices, and CI/CD setup for rapid project development.",

0 commit comments

Comments
 (0)