mirror of https://github.com/fluffos/fluffos synced 2026-08-12 18:26:06 -04:00

Add local search and documentation guide for docs site (#1221 )

* docs: add local full-text search and a contributor README

Add @easyops-cn/docusaurus-search-local to the Docusaurus site so the
docs get an offline search bar (index built at build time, no external
service). English and zh-CN pages are both indexed, and matched terms
are highlighted on the target page.

Add docs/README.md describing the Docusaurus setup, local dev/build
commands, search behavior, directory layout, and gotchas; exclude it
from the published site alongside CLAUDE.md. Point the root README's
docs/ entry at it.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01TSzcESzU9947zkGzQ6SMmE

* docs: remove dead framework leftovers, fix index generation, complete the nav

Delete the VitePress (.vitepress/) and Jekyll (_layouts/, css/) leftovers,
the one-shot migration scripts (fix_md_header.py, fix_seealso.py), and the
stale keywords.json snapshot; prune the matching .gitignore entries and
docusaurus exclude patterns.

Rewrite gen_index.py for Docusaurus: it emitted dead .html links and
legacy 'layout: doc' frontmatter, choked on non-markdown entries, and
dropped nested categories — regenerating an index would have broken it.
It now emits the extension-less links the site actually uses, links
nested category indexes (restoring apply/* on the zh-CN index), and
refuses to run on the docs root. Fix update_index.sh's copy-paste titles
(zh-CN efun/build were titled 'APPLY'), stop it clobbering the
hand-written lpc/index.md, and cover cli/. Regenerated indexes pick up
the missing driver/ffi-plan entry. add_missing_efuns.py now takes the
keywords.json path as an argument instead of requiring a stale copy.

Move CNAME and the Google site-verification file into static/ so they
actually reach the published build output.

Complete the sidebar: link the CLI category to cli/index and add the
missing portbind/symbol/generate_keywords pages, and expose the
previously orphaned stdlib section under Reference.

Promote onBrokenLinks to 'throw' now the build is warning-free, and drop
the empty Demo section from the landing page.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01TSzcESzU9947zkGzQ6SMmE

* docs: strip legacy 'layout: doc' frontmatter from all pages

Mechanical sweep removing the Jekyll-era 'layout: doc' line from every
doc page's frontmatter (Docusaurus ignores it), and the matching line
from the templates in docs/CLAUDE.md so new pages don't reintroduce it.
No content changes.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01TSzcESzU9947zkGzQ6SMmE

---------

Co-authored-by: Claude <noreply@anthropic.com>

2026-07-09 22:09:55 -04:00

2.8 KiB

Raw Permalink Blame History

title
cli / generate_keywords

cli / generate_keywords

generate_keywords is a development utility that generates a JSON file containing metadata for all LPC efuns (external functions).

Usage

./generate_keywords

Description

This tool extracts information about all available efuns from the compiled FluffOS driver and generates a keywords.json file containing structured metadata about each function. This file is useful for:

IDE Integration: Language servers and code editors can use this file to provide autocomplete and type hints
Documentation Generation: Automated documentation tools can extract function signatures
Static Analysis: Code analysis tools can validate LPC code against available efuns
API Reference: Developers can query available functions and their signatures

Output Format

The tool generates a keywords.json file in the current directory with the following structure:

[
  {
    "name": "function_name",
    "type": "efun",
    "returns": "return_type",
    "min_args": 0,
    "max_args": 2,
    "args_types": [
      ["type1", "type2"],
      ["type3"]
    ]
  },
  ...
]

Output Fields

name: The efun name
type: Always "efun" for external functions
returns: The return type of the function
min_args: Minimum number of required arguments
max_args: Maximum number of arguments (-1 for variadic)
args_types: Array of argument type possibilities for each parameter position

Example Output

[
  {
    "name": "write",
    "type": "efun",
    "returns": "void",
    "min_args": 1,
    "max_args": 1,
    "args_types": [
      ["mixed"]
    ]
  },
  {
    "name": "hash",
    "type": "efun",
    "returns": "string",
    "min_args": 2,
    "max_args": 2,
    "args_types": [
      ["string"],
      ["string"]
    ]
  }
]

Requirements

Must be run from the FluffOS build directory
Requires write permissions in the current directory
The driver must be successfully compiled with all packages

Use Cases

VSCode/Language Server Integration:

// Language server can parse keywords.json to provide:
// - Autocomplete for efun names
// - Parameter hints
// - Type checking

Documentation Automation:

# Generate keywords.json then process it
./generate_keywords
node doc-generator.js keywords.json > efun-reference.md

Notes

This is a development/build tool, not needed for runtime operation
The output reflects the exact efuns available in the compiled build
Package-specific efuns only appear if their packages are enabled
Run this after any build configuration changes to update the keywords

2.8 KiB Raw Permalink Blame History