Skip to content

Proposal: stabilize gendoc action #1774

Description

@champignoom

The current gendoc action installs neorg itself and all its dependencies before generating neorg's own wiki, which is crucial for welcoming new neorg users.

As elegant as it may sound, such bootstrapping is far from reliable for neorg. See #1770 #1771 #1772 #1773. Given the track record of instability, such problem will likely persist.

Unlike usual bugs, doc problems could make neorg completely garbage except for the writer of latest commit.

The proposal is to stabilize gendoc action by decoupling neorg itself from neorg wiki generation, specifically replacing the scattered, dynamically generated docs with somewhat centralized docs. This might incur inconsistency between doc and code, but the current generated docs with deeply nested sparse information provides little advantage over reading code itself anyway.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions