Skip to content

Documentation improvement suggestions #174

Description

@korgano

The documentation is a bit lacking in a few areas.

Most notable of these are the fact that there is too much information compiled into a single page, arguably too much repetition of the same information, missing details on how certain parameters work, and no images to visualize the effects of the parameters that affect how the prompt or output appears.

My proposed rework of the documentation is to split out the sections into their own pages:

  • Basic Components
  • Intentions
  • Role
  • Data Displays
  • Utilities

Then add a new page, Formatting, to showcase what specific components and parameters can change in the prompt or output. This would be the page to provide images for some of the more esoteric parameters, such as position or speaker, whose effects are underexplained in the existing documentation.

That would make things a lot more manageable when trying to find specific information while crafting prompts.

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

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions