Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better markdown integration #32

Open
RossBencina opened this issue Sep 1, 2023 · 0 comments
Open

Better markdown integration #32

RossBencina opened this issue Sep 1, 2023 · 0 comments
Labels
enhancement New feature or request

Comments

@RossBencina
Copy link
Member

RossBencina commented Sep 1, 2023

The following areas relating to prapti markdown have been identified for improvement:

  • The use of ### level 3 headings for delimiting message sections has been criticised as arbitrary. Furthermore, if your view of a Markdown document is as an outline structure of nested headings, then any use of headings as message delimiters may be confusing. For example, we use L3 headings as delimiters, but we do not terminate a message section when an L2 heading is encountered. Possible improvement:

    • Allow any heading level to stand in for a message delimiter
    • Consider alternative ways of parsing out a message sequence from the heading hierarchy (e.g. allow L2 to start a hidden section after encountering an L3 message heading)
  • Right now, the parser considers any line that matches our regex as a heading. In fact we should not be recognising message delimiter headings inside fenced code blocks.

  • We may want to treat roles in message headings as case insensitive. E.g. "User" and "USER" might also be considered reasonable presentation in some settings (e.g. OpenAI docs display example conversations using User: and System: headings.)

  • HTML <!-- --> comments are part of the markdown spec. We may want to interpret them as "commenting out" sections of the file, and not send these parts to the LLM.

  • Don't match % config lines inside HTML comments or fenced code blocks (the latter is somewhat important when using prapti to document prapti configurations)

@RossBencina RossBencina added the enhancement New feature or request label Sep 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant