Unverified Commit b953a849 authored by Hong Minhee's avatar Hong Minhee
Browse files

Fix docs

parent ae79e3c9

.github/workflows/build.yaml

+7 −7
Original line number Diff line number Diff line
@@ -268,26 +268,26 @@ jobs: 
      url: ${{ steps.deployment.outputs.page_url }}

    steps:

    - uses: actions/checkout@v4

    - uses: oven-sh/setup-bun@v1

    - uses: pnpm/action-setup@v4

      with:

        bun-version: latest

        version: 10

    - run: |

        set -ex

        bun install

        pnpm install

        if [[ "$GITHUB_EVENT_NAME" = "push" && "$GITHUB_REF_TYPE" = "tag" ]]; then

          bun add -Df --no-cache "@fedify/fedify@$GITHUB_REF_NAME"

          pnpm add -D "@fedify/fedify@$GITHUB_REF_NAME"

          EXTRA_NAV_TEXT=Unstable \

          EXTRA_NAV_LINK="$UNSTABLE_DOCS_URL" \

          SITEMAP_HOSTNAME="$STABLE_DOCS_URL" \

          JSR_REF_VERSION=stable \

          bun run build

          pnpm run build

        else

          bun add -Df --no-cache @fedify/fedify@dev

          pnpm add -D @fedify/fedify@dev

          EXTRA_NAV_TEXT=Stable \

          EXTRA_NAV_LINK="$STABLE_DOCS_URL" \

          SITEMAP_HOSTNAME="$UNSTABLE_DOCS_URL" \

          JSR_REF_VERSION=unstable \

          bun run build

          pnpm run build

        fi

      env:

        PLAUSIBLE_DOMAIN: ${{ secrets.PLAUSIBLE_DOMAIN }}

CONTRIBUTING.md

+5 −3
Original line number Diff line number Diff line
@@ -259,13 +259,15 @@ with Node.js and Bun. 
### Building the docs



If you want to change the Fedify docs, you would like to preview the changes

in the browser.  To do that, you need to install [Bun] first.

in the browser.  To do that, you need to install [Node.js] and [pnpm] first.

Then you can run the following commands at the *docs/* directory:



~~~~ bash

bun install

bun dev

pnpm install

pnpm dev

~~~~



Once the development server is running, you can open your browser and navigate

to *http://localhost:5173/* to view the docs.



[pnpm]: https://pnpm.io/

docs/bun.lock

deleted100644 → 0
+0 −1339

File deleted.

Preview size limit exceeded, changes collapsed.

docs/manual/log.md

+2 −1
Original line number Diff line number Diff line
@@ -376,7 +376,8 @@ class AsyncLocalStorage<T> implements ContextLocalStorage<T> { 
}

// ---cut-before---

import { AsyncLocalStorage } from "node:async_hooks";

import { type LogRecord, configure, getFileSink } from "@logtape/logtape";

import { getFileSink } from "@logtape/file";

import { type LogRecord, configure } from "@logtape/logtape";



await configure({

  sinks: {

docs/package.json

+5 −3
Original line number Diff line number Diff line
@@ -3,12 +3,13 @@ 
    "@braintree/sanitize-url": "^7.1.1",

    "@deno/kv": "^0.8.4",

    "@fedify/amqp": "^0.2.0",

    "@fedify/fedify": "^1.6.0-dev.768",

    "@fedify/fedify": "^1.6.1-dev.828",

    "@fedify/postgres": "^0.3.0",

    "@fedify/redis": "^0.4.0",

    "@hono/node-server": "^1.13.7",

    "@js-temporal/polyfill": "^0.5.0",

    "@logtape/logtape": "^0.8.0",

    "@js-temporal/polyfill": "^0.5.1",

    "@logtape/file": "^0.10.0",

    "@logtape/logtape": "^0.10.0",

    "@opentelemetry/exporter-trace-otlp-proto": "^0.57.0",

    "@opentelemetry/sdk-node": "^0.57.0",

    "@sentry/node": "^8.47.0",
@@ -17,6 +18,7 @@ 
    "@types/amqplib": "0.10.6",

    "@types/better-sqlite3": "^7.6.12",

    "@types/bun": "^1.1.14",

    "@types/node": "^22.15.21",

    "amqplib": "^0.10.5",

    "dayjs": "^1.11.13",

    "hono": "^4.6.14",