docs tweaks #70
docs tweaks #70
Conversation
There was a problem hiding this comment.
Looks great, only styling tweak I'd look into is the font size for code samples. Given the narrow layout for a doc, I in Tools you end up with a lot of overflow to scroll through. There's some with the original samples, but a lot less has been chopped off such that you can kind of guess what the end of a line is.
There was a problem hiding this comment.
Defaulting to more horizontal space is the only change request here. Accomplished by removing max-w-3xl and defaulting to the top nav.
This is a great start, look forward to seeing how this develops. Would love to have this be part of my workflow whenever I start a new page and layout for a feature.
| window.localStorage.setItem(key, layout) | ||
| } | ||
|
|
||
| return window.localStorage.getItem(key) || "SidebarLayout" |
There was a problem hiding this comment.
I would use StackedLayout as the default here to maximize horizontal space.
| * these options are used only in the instantiation | ||
| * of a new UseBaseAPI composable | ||
| */ | ||
| export interface UseBaseAPIOptions extends ReqOptions { |
There was a problem hiding this comment.
I wonder if 1. we could write our implementation such that it's importable here rather than redefining and 2. if it's even possible to import code here from elsewhere in the project. Just food for thought, nothing to do now
| @@ -1,8 +1,8 @@ | |||
| <script setup lang="ts"> | |||
| import { ref } from "vue" | |||
| import ColorRow from "../../dev/helpers/ColorRow.vue" | |||
| import ColorRow from "../components/ColorRow.vue" | |||
There was a problem hiding this comment.
It would be nice to remove max-w-3xl from all of our page containers to get more horizontal space.
|
@DavidLarsKetch @profsmallpine I'll add the requested changes on once I merge it all together. The doc's width change will make a mess of the diffs. |
What this does
This is a WIP ugly update to how docs are written for Trees. A number of pain points have made writing docs difficult, this starts to alleviate some of them. Specifically, adding code examples has been frustrating with how Vue SFC's compile and how prettier parses those files. This starts to introduce markdown files that for now are mostly used for displaying code samples.
/docsdirectory via tsconfig updates and global component type declarations