docs: split README into focused docs/ pages - #61
Merged
Conversation
rachfop
marked this pull request as ready for review
August 26, 2026 20:58
rachfop
added a commit
to portdeveloper/docusaurus-plugin-llms-fork
that referenced
this pull request
Sep 1, 2026
Rebased onto current main (README was split into docs/ pages in rachfop#61, so the section now lives in docs/best-practices.md). Co-authored-by: port <port@portdevs.com>
rachfop
added a commit
that referenced
this pull request
Sep 1, 2026
Rebased onto current main (README was split into docs/ pages in #61, so the section now lives in docs/best-practices.md). Co-authored-by: rachfop <prachford@icloud.com> Co-authored-by: port <port@portdevs.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Splits the 1,303-line monolithic README into 9 focused pages under
docs/, and slims the README to a landing page (description, features, quick start, links).Pages
docs/overview.md,installation.md,configuration.md,content-generation.md,markdown-files.md,content-cleaning.md,ordering-and-paths.md,multi-version.md,best-practices.mdAlong the way, corrected README-vs-source drift
Every page verified option names/types/defaults against
PluginOptionsinsrc/types.ts. Fixes folded into the docs:warnOnIgnoredFilesexisted in source but was missing from the options table — added.generateMarkdownFilesfilename priority documented per the real code (frontmatterslug→id→ resolved URL → sanitized title), not the README's claimed order.# Create User Account,# API Authentication, etc.) that had leaked into the README as sections are now folded into code examples.Follow-up (source bug, not fixed here)
CustomLLMFile.includeUnmatchedLast— the JSDoc insrc/types.tsand the old README say defaultfalse, butgenerator.tsuses?? true. The docs describe the effective behavior (true); the JSDoc should be corrected separately.README: 1,303 → 57 lines. All cross-links verified to resolve.
tscbuild unaffected.