docs v2 #659
Open
docs v2 #659
Conversation
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
🦋 Changeset detectedLatest commit: 781b0f2 The changes in this PR will be included in the next version bump. This PR includes changesets to release 8 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Contributor
built with Refined Cloudflare Pages Action⚡ Cloudflare Pages Deployment
|
commit: |
* fix for empty layers toggle showing small circle
* initial
* move to footer
* Landing Page Stats
- Stats handled by src/lib/Stats.svelte
- stats loaded via svelte remote function $lib/stats.remote.ts
- stats nonblock via {#await}
- for scrolling NPM downloads - Used ScrollValue from Svelte-UX
- npm scrolling paused if not in viewport (used runed inViewport). This allows for consistent 1st visualization.
- npm scrolling also pauses if npm hovered - less jarring
- all stats are links to corresponding pages (NPM, Github, Discord, Bluesky)
- responsive design dropping to block at small screens
* refine using runed's useInterval with pause/resume
* Use `GITHUB_API_TOKEN` if available (docs/.env, env var). Improve error handling
---------
Co-authored-by: Sean Lynch <[email protected]>
* fix for empty layers toggle showing small circle * missing-clips
* Open in LLM feature
* removed grok
* open-in-llm-component
- rewrote copy for LLMs
* minor copy change
* used markdown icons
* llms.txt - 3 levels
1. Individual pages like `layerchart.com/docs/components/Linechart/llms.txt .`
2. Site links index at `layerchart.com/llms.txt`
3. Complete text at `layerchart.com/docs/llms.txt .`
API endpoint creation for sections
1. Getting Started
2. Guide Pages
3. Components
4. Individual Examples
5. Utils
Added processMarkdownContent(content) to handle custom markdown conversion to vanilla MD for LLMs. In `docs/src/lib/markdown/utils.ts`
* fix spelling error
* another spelling fix
* Change OpenLLMs.svelte to OpenWithButton.svelte
- cleaned up logic on `ddocs/src/routes/docs/guides/[name]/llms.txt/+server.ts` was getting title by url name, now uses frontmatter like others.
* Change "View Page Markdown" to open in modal
* refine OpenWithButton
* update `p` markdown component to only apply margins when within main (not nested in note, blockquote, etc)
* refine some wording
* Create guides content collection and use to build menu
* Extract and consolidate common llms.txt utils
* Add common sortCollection util
* add component links to examples llms.txt
* consolidate more logic into llms/utils.ts
* Replace `fs`/`path` usage with Vite's `import.meta.glob`
* Move processMarkdownContent to llms/utils.ts
* processMarkdownContent within generateComponentMarkdown / generateUtilMarkdown
* include `:example { }`directives
* cleanup
* move related section to bottom of component docs (also matches llms.txt)
* Add examples to component llms.txt
* Rename `Component docs` to just `Components` when viewing an example
* Extract generateExampleMarkdown from request handler into llms/tuils.ts
* move generateFullLlmsTxt to llms/utils.ts, always use markdownResponse (remove textResponse)
* move generateLlmsTxt to llms/utils.ts,
* replace generateGuidesSection with generateCollectionListSection
* Uwe docsUrl in `inlineExampleDirectives` and `generateComponentMarkdown` to build example links
* remove unneeded exports
* cleanup types
* delete outdated tests
* update docs test setup to match packages/layerchart
* add llms tests and add to ci
* Add LLMs link to frontpage footer
* Update LLMs docs
* Disable docs tests until contentCollections() can be enabled without triggering `__dirname is not defined`
---------
Co-authored-by: Sean Lynch <[email protected]>
…o v2). If dagre was bumped to v2, was getting: `"Dynamic require of "@dagrejs/graphlib" is not supported"`
* fix for empty layers toggle showing small circle * add missing clips for tree examples
…e when to display toc. Add toc to getting starting but disable until heading improved
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Goals
$prop()types)Closes #620
PR also
layertype anddebug)layersetting (default)debugsetting (overall and padding bounds)TODO
Existing
{project_root}/docs}renderContext(svg/canvas/html) settingdebugsetting?rawfor source)<script>)datawarning (box value in object)New
llms.txt<Layer type={shared.renderContext}}>with set value (ex.<Layer type="svg"}>Structure
I'm also thinking we have the following sections (not rigid, but general ideas):
possibly
Issues