Unverified Commit 2bf37689 authored by Hong Minhee's avatar Hong Minhee
Browse files

NodeInfo docs 

[ci skip]
parent aa5e275d

docs/manual/nodeinfo.md

+13 −4
Original line number Diff line number Diff line
@@ -94,10 +94,15 @@ The `NodeInfo` interface is defined as follows: 


`software.version`

:   *Required.*  The version of the server software.  This must be a valid

    `SemVer` object.  For your information, a Semantic Versioning string

    can be parsed into a `SemVer` object using `parseSemVer()` function.

    In the other way around, you can render a `SemVer` object into a Semantic

    Versioning string using `formatSemVer()` function.

    [`SemVer`] object.  For your information, a Semantic Versioning string

    can be parsed into a [`SemVer`] object using [`parseSemVer()`] function.

    In the other way around, you can render a [`SemVer`] object into a Semantic

    Versioning string using [`formatSemVer()`] function.



    > [!TIP]

    > The [`SemVer`] type, and the [`parseSemVer()`] and [`formatSemVer()`]

    > functions are provided by the [@std/semver] package, but for convenience,

    > Fedify re-exports them.



`software.repository`

:   The [`URL`] of the source code repository of the server software.
@@ -142,6 +147,10 @@ The `NodeInfo` interface is defined as follows: 
    the server.  This `number` has to be an integer greater than or equal to

    zero.



[`SemVer`]: https://jsr.io/@std/semver/doc/~/SemVer

[`parseSemVer()`]: https://jsr.io/@std/semver/doc/~/parse

[`formatSemVer()`]: https://jsr.io/@std/semver/doc/~/format

[@std/semver]: https://jsr.io/@std/semver

[`URL`]: https://developer.mozilla.org/en-US/docs/Web/API/URL

docs/package.json

+1 −1
Original line number Diff line number Diff line
@@ -3,7 +3,7 @@ 
    "@braintree/sanitize-url": "^7.1.0",

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

    "@fedify/amqp": "0.1.0-dev.8",

    "@fedify/fedify": "1.1.0-dev.432",

    "@fedify/fedify": "1.2.0-dev.452",

    "@fedify/postgres": "0.1.0-dev.2",

    "@fedify/redis": "0.2.0-dev.10",

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

docs/pnpm-lock.yaml

+5 −5
Original line number Diff line number Diff line
@@ -18,8 +18,8 @@ importers: 
        specifier: 0.1.0-dev.8

        version: 0.1.0-dev.8(web-streams-polyfill@3.3.3)

      '@fedify/fedify':

        specifier: 1.1.0-dev.432

        version: 1.1.0-dev.432(web-streams-polyfill@3.3.3)

        specifier: 1.2.0-dev.452

        version: 1.2.0-dev.452(web-streams-polyfill@3.3.3)

      '@fedify/postgres':

        specifier: 0.1.0-dev.2

        version: 0.1.0-dev.2(web-streams-polyfill@3.3.3)
@@ -401,8 +401,8 @@ packages: 
  '@fedify/fedify@1.0.2':

    resolution: {integrity: sha512-OWVfahJRstzCOGSEDJ5CEppVHZyR9IfpFStj1WnedLE6rFoYZ94fZu7dQv4x0M1a1K3AfIiwvOAgcXldy21sWg==}



  '@fedify/fedify@1.1.0-dev.432':

    resolution: {integrity: sha512-SefxERpwvX5BPPon6bM2hTy64YuuVJIUuytUYN/U7fOiGLrOTQiMZoOUxi7PJnKDaf5tNwaMhvoWwp4n0ULt1w==}

  '@fedify/fedify@1.2.0-dev.452':

    resolution: {integrity: sha512-S7oJFVOcn5Z0r1RIQhI7XjbYqna6dziwSxBURXiYp+3OBrTYnn1wKsQ0CFslRRr8hSC5yOWvuER+wDvvvsZXdw==}



  '@fedify/postgres@0.1.0-dev.2':

    resolution: {integrity: sha512-KeLhfRgprJF7EXVgzPBRQAJKHnX79IdoZgrWWqD78bAIx3IiRLMXc+LS7/UmQaD0PiNmFXK+cUzKUE00/HbyDg==}
@@ -2074,7 +2074,7 @@ snapshots: 
    transitivePeerDependencies:

      - web-streams-polyfill



  '@fedify/fedify@1.1.0-dev.432(web-streams-polyfill@3.3.3)':

  '@fedify/fedify@1.2.0-dev.452(web-streams-polyfill@3.3.3)':

    dependencies:

      '@deno/shim-crypto': 0.3.1

      '@deno/shim-deno': 0.18.2