universal-ember/kolay

Docs system based on markdown files living in the public folder.

kolay's Issues

Add documentation

implement

• set custom page sorting
• set custom folder sorting
• add custom remark plugins (already supported by ember-repl)
• ability to gather markdown from other locations (copyFile, likely already does this, but needs tested)

docs

• show how to work with the manifest (service)
• show how to retrieve the compiled markdown (service)
• meta.json/jsonc

SSG (Static Site Generation)

It should be possible, once migrated to Vite, to statically generate most of the docs for most pages.

The only exception is going to be when there is a live tag on a codefence AND that output code has interactivity (a, button, input, etc).
That bit will still require javascript, but most live codefences should even be able to be statically burned in to the page.

Todos:

• TypeStrong/typedoc#2528
• #40
• A Vitepress plugin?
  • vuejs/vitepress#3676 (comment)

Alternatives / partial implementation:

• The Docfy approach -- except only during a production build and actually emit all the pages to hand off to a static renderer (vite-ssr?)
  This would likely require being opt-in, because it is a tradeoff with the low-build time approach currently implemented

References

• https://vitejs.dev/guide/ssr

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• Update pnpm to v8.15.7
• Update devDependencies (@embroider/addon-dev, @embroider/compat, @embroider/core, @typescript-eslint/eslint-plugin, @typescript-eslint/parser, babel-plugin-ember-template-compilation, ember-cli, ember-primitives, ember-source, qunit-dom, release-plan, rollup, stylelint, vite)
• Update devDependencies (major) (@embroider/webpack, ember-template-lint, eslint, eslint-plugin-n)
• Update pnpm to v9
• Lock file maintenance
• Click on this checkbox to rebase all open PRs at once

Detected dependencies

github-actions

.github/workflows/ci.yml

• wyvox/action v1
• wyvox/action v1
• wyvox/action v1
• wyvox/action v1

.github/workflows/plan-release.yml

• actions/checkout v4
• actions/checkout v4
• wyvox/action-setup-pnpm v3
• peter-evans/create-pull-request v6

.github/workflows/publish.yml

• actions/checkout v4
• actions/checkout v4
• wyvox/action-setup-pnpm v3

docs-app/.github/workflows/ci.yml

• actions/checkout v4
• actions/setup-node v4
• actions/checkout v4
• actions/setup-node v4

npm

docs-app/package.json

• @babel/core ^7.23.6
• @babel/eslint-parser ^7.23.3
• @babel/plugin-proposal-decorators ^7.23.6
• @ember/optional-features ^2.0.0
• @ember/string ^3.1.1
• @ember/test-helpers ^3.3.0
• @ember/test-waiters ^3.1.0
• @embroider/compat ^3.4.3
• @embroider/core ^3.4.3
• @embroider/webpack ^3.2.1
• @glimmer/component ^1.1.2
• @glimmer/tracking ^1.1.2
• @glint/core ^1.3.0
• @glint/environment-ember-loose ^1.3.0
• @glint/environment-ember-template-imports ^1.3.0
• @glint/template ^1.3.0
• @nullvoxpopuli/eslint-configs ^3.2.2
• @tsconfig/ember ^3.0.3
• @types/qunit ^2.19.10
• broccoli-asset-rev ^3.0.0
• concurrently ^8.2.2
• ember-auto-import ^2.7.0
• ember-cli ~5.7.0
• ember-cli-app-version ^6.0.1
• ember-cli-babel ^8.2.0
• ember-cli-clean-css ^3.0.0
• ember-cli-dependency-checker ^3.3.2
• ember-cli-htmlbars ^6.3.0
• ember-cli-inject-live-reload ^2.1.0
• ember-load-initializers ^2.1.2
• ember-modifier ^4.1.0
• ember-page-title ^8.1.0
• ember-primitives ^0.12.0
• ember-qunit ^8.0.2
• ember-resolver ^11.0.1
• ember-resources ^7.0.0
• ember-source ~5.7.0
• ember-template-imports ^4.0.0
• ember-template-lint ^5.13.0
• ember-welcome-page ^7.0.2
• eslint ^8.55.0
• eslint-config-prettier ^9.1.0
• eslint-plugin-ember ^12.0.0
• eslint-plugin-n ^16.4.0
• eslint-plugin-prettier ^5.0.1
• eslint-plugin-qunit ^8.1.1
• loader.js ^4.7.0
• pnpm-sync-dependencies-meta-injected ^0.0.10
• prettier ^3.1.1
• prettier-plugin-ember-template-tag ^2.0.0
• qunit ^2.20.0
• qunit-dom ^3.0.0
• stylelint ^16.2.1
• stylelint-config-standard ^36.0.0
• stylelint-prettier ^5.0.0
• tracked-built-ins ^3.3.0
• typescript ^5.3.3
• webpack ^5.90.3

package.json

• @arethetypeswrong/cli ^0.15.0
• @ember/test-waiters ^3.1.0
• @glimmer/component ^1.1.2
• @glimmer/tracking ^1.1.2
• @glint/core ^1.3.0
• @glint/template ^1.3.0
• @nullvoxpopuli/eslint-configs ^3.2.2
• @tsconfig/node20 ^20.1.2
• @tsconfig/strictest ^2.0.3
• @types/common-tags ^1.8.4
• @types/qunit ^2.19.10
• @types/rsvp ^4.0.9
• @typescript-eslint/eslint-plugin ^7.0.1
• @typescript-eslint/parser ^7.0.1
• concurrently ^8.2.2
• ember-modifier ^4.1.0
• ember-primitives ^0.12.0
• ember-repl ^4.1.1
• ember-resources ^7.0.0
• ember-source ~5.7.0
• eslint ^8.56.0
• pnpm-sync-dependencies-meta-injected ^0.0.10
• prettier ^3.1.1
• publint ^0.2.7
• reactiveweb ^1.2.1
• release-plan ^0.8.0
• tracked-built-ins ^3.3.0
• turbo ^1.12.3
• typescript ^5.3.3
• vite ^5.1.3
• vitest ^1.2.2
• webpack ^5.90.3
• node 20.12.2
• pnpm 8.15.6
• @ember/test-waiters ^3.1.0
• webpack ^5.90.3
• ember-repl ^4.1.1

ui/package.json

• @babel/core ^7.23.6
• @babel/eslint-parser ^7.23.3
• @babel/plugin-transform-typescript ^7.23.6
• @babel/preset-typescript ^7.23.3
• @babel/runtime ^7.17.0
• @embroider/addon-dev 4.2.1
• @glint/core ^1.3.0
• @glint/environment-ember-loose ^1.3.0
• @glint/environment-ember-template-imports ^1.3.0
• @glint/template ^1.3.0
• @nullvoxpopuli/eslint-configs ^3.2.2
• @rollup/plugin-babel ^6.0.4
• @tsconfig/ember ^3.0.3
• @types/qunit ^2.19.10
• babel-plugin-ember-template-compilation ^2.2.1
• concurrently ^8.2.2
• ember-modifier ^4.1.0
• ember-repl ^4.1.1
• ember-source ~5.7.0
• ember-template-lint ^5.13.0
• eslint ^8.56.0
• eslint-config-prettier ^9.1.0
• eslint-plugin-ember ^12.0.0
• eslint-plugin-n ^16.4.0
• eslint-plugin-prettier ^5.0.1
• execa ^8.0.1
• fix-bad-declaration-output ^1.1.4
• prettier ^3.1.1
• prettier-plugin-ember-template-tag ^2.0.0
• qunit ^2.20.0
• reactiveweb ^1.2.1
• rollup ^4.12.1
• rollup-plugin-copy ^3.5.0
• tracked-built-ins ^3.3.0
• typescript ^5.3.3
• unified ^11.0.4

---

• Check this box to trigger a request for Renovate to run again on this repository

Figure out a way to have a virtual module import another virtual module

Right now, folks have to do this in their apps:

await this.docs.setup({
  apiDocs: await import('kolay/api-docs:virtual'),
  manifest: await import('kolay/manifest:virtual'),
  resolve: {
    'my-library': await import('my-library'),
    'something-else': await import('something-else'),
  },
});

This isn't great because:

• it's a bit of ceramony
• two imports instead of one
• two minimum properties, ideal would be 0 (resolve is optional)

previously issues that are now non issues

• microsoft/TypeScript#57529~~

If we can shorten this down to a single import, the whole thing could be:

import { setupKolay } from 'kolay/setup'; // a virtual module

// ...
const manifest = await setupKolay({
  resolve: {
    'my-library': await import('my-library'),
    'something-else': await import('something-else'),
  },
});

which, I think, makes more sense, and kolay/setup is easy to provide type definitions for.

But, so far, a virtual module cannot import another virtual module, because plugins' resolve hooks are only used when resolving from the consuming app and a virtual module is kind of in a void of its own.