Skip to content

README is effectively a full site flattened into one file #682

Description

@javeoff

Ran into your README while looking at graph-native Text2SQL tools — 19k+ characters in one file, and setup, architecture, and API usage are all flattened into it with no way to search or link a specific section. For a repo that shipped a commit today and sits at 1000+ stars, that is a lot of surface area nobody can navigate.

Split it into a real docs site to see how it would read: falkordb docsbook io — same repo content, just searchable, with working AI answers over it instead of ctrl+F.

Curious whether a docs/ split is on your radar, or if the flat README is intentional for now.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    questionFurther information is requested

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions