Skip to content

Generate Markdown Docs #1713

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

Open
wants to merge 9 commits into
base: master
Choose a base branch
from
Open

Conversation

ghedwards
Copy link

No description provided.

@pfreitag
Copy link
Member

@ghedwards - can you provide some background for the reason for doing this? I assume it has something to do with making it easier for LLM's to read the docs. Is there a reason for putting them in the /docs sub folder? the guides are already written in markdown so we are just moving those files.

@ghedwards
Copy link
Author

@pfreitag context7 LLM / MCP but also cfmleditor.github.io/cfdocs

@ghedwards
Copy link
Author

Without markdown docs

image

With markdown docs

image

@ghedwards
Copy link
Author

@pfreitag ?

@pfreitag
Copy link
Member

@ghedwards still thinking this one through, since it is going to add a ton of files to the repo, and also requires frequent updating. Would it be possible for us to convert and generate the markdown on demand on cfdocs.org and then just point the tool there? or does it need to be in the github repo?

@pfreitag
Copy link
Member

What if we just dynamically generate a llms.txt file with all the current docs for example, it looks like context7 can import that.

@ghedwards
Copy link
Author

@pfreitag if the generation is on the table why not individual .MD files, it also reduces the reliance and traffic to the cfdocs website, from llms at least.

@garethedwards-tass
Copy link

@pfreitag any update on this ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants