Skip to content

Instructions CLI argument to generate custom documentation. #179

Description

@richie-rk

Currently the output is always a beginner-friendly tutorial. It would be useful to let users guide the document style, for example, a feature doc from a user perspective, an architecture overview, or an API reference.

My suggestion is to add a --instructions flag that passes custom instructions into each LLM prompt, similar to how --language works.

python main.py --repo <url> --instructions "Write a feature document from a user perspective"

When omitted, behavior is unchanged. I have a working implementation in my fork. I'm happy to open a PR if this fits the project direction.

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

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions