Extract docs #70

tmlayton · 2021-04-05T18:25:32Z

Todo

Content todo

Write examples for vanilla JS and React
Pull markdown formatting out and place in content files (e.g. CalloutBanner "Guidelines")
Update all doc comments to inline content. Flatten any lists or move to /content markdown files.
Move any doc comments to interfaces. Comments on type’s used in interfaces are not parsed.

Co-authored-by: Tim Layton <[email protected]>

iainmcampbell · 2021-04-29T18:38:37Z

CI is failing on what appears to be a lack of dom types (ReactiveX/rxjs#1986 (comment))

…however, we already include the dom library in our compilerOptions in tsconfig.base.json 🤔

tmlayton · 2021-04-29T23:27:27Z

It looks like the TS config for the argo-checkout package is being used, which appears to overwrite the array of lib's when using a base config instead of merging them. When I swap WebWorker with dom the error goes away but I get another error related to the global declaration for shopify, it’s also not the right thing to do. I tried using both the web worker and dom libs but it throws a bunch of conflict errors.

Update: looks like this is a known error with projects that want to use both the web worker and dom libraries and a few workarounds here microsoft/TypeScript#20595

iainmcampbell · 2021-05-03T20:30:12Z

I want to merge this in cause it's becoming a pain to rebase. It's also modular enough that Admin and Checkout can build on this separately.

The scripts are still WIP but if you wanna test them, make sure you have shopify-dev cloned and run yarn docs:admin or yarn docs:checkout.

tmlayton · 2021-05-04T05:33:14Z

Not sure how I feel about the skipLibCheck in the base config, we should be able to instead move the scripts to their own area with their own tsconfig which includes the dom lib.

Otherwise I’m fine with merging. If you do so I just ask that you move the outstanding todos to their own issues.

iainmcampbell · 2021-05-04T15:52:55Z

@tmlayton tried that, can't seem to get it to work, see last commit

vividviolet

I couldn't get very far for testing unfortunately

vividviolet · 2021-05-04T18:33:09Z

scripts/typedoc/shopify-dev-renderer/index.ts

+
+export {extensionPoints, components, gettingStarted};
+
+export function renderForShopifyDev(paths: Paths) {


Can we clone shopify-dev if it doesn't already exist? I'm getting this error when running the command without the dev repo cloned:

node:internal/fs/utils:343 throw err; ^ Error: ENOENT: no such file or directory, mkdir '/Users/trishta/src/github.com/Shopify/shopify-dev/content/docs/checkout-extensions' at Object.mkdirSync (node:fs:1038:3) at gettingStarted (/Users/trishta/src/github.com/Shopify/argo-checkout/scripts/typedoc/shopify-dev-renderer/getting-started.ts:15:8) at renderForShopifyDev (/Users/trishta/src/github.com/Shopify/argo-checkout/scripts/typedoc/shopify-dev-renderer/index.ts:12:3) at Object.<anonymous> (/Users/trishta/src/github.com/Shopify/argo-checkout/scripts/generate-docs-checkout.ts:13:1) at Module._compile (node:internal/modules/cjs/loader:1108:14) at Module._compile (/Users/trishta/src/github.com/Shopify/argo-checkout/node_modules/pirates/lib/index.js:99:24) at Module._extensions..js (node:internal/modules/cjs/loader:1137:10) at Object.newLoader [as .ts] (/Users/trishta/src/github.com/Shopify/argo-checkout/node_modules/pirates/lib/index.js:104:7) at Module.load (node:internal/modules/cjs/loader:988:32) at Function.Module._load (node:internal/modules/cjs/loader:828:14) { errno: -2, syscall: 'mkdir', code: 'ENOENT', path: '/Users/trishta/src/github.com/Shopify/shopify-dev/content/docs/checkout-extensions'

Second error after cloning shopify-dev:

node:fs:506 handleErrorFromBinding(ctx); ^ Error: ENOENT: no such file or directory, open '/Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts' at Object.openSync (node:fs:506:3) at readFileSync (node:fs:402:35) at extractModule (/Users/trishta/src/github.com/Shopify/argo-checkout/scripts/typedoc/utilities/dependency-graph.ts:134:18) at process (/Users/trishta/src/github.com/Shopify/argo-checkout/scripts/typedoc/utilities/dependency-graph.ts:113:30) at take (/Users/trishta/src/github.com/Shopify/argo-checkout/scripts/typedoc/utilities/dependency-graph.ts:90:9) at /Users/trishta/src/github.com/Shopify/argo-checkout/scripts/typedoc/utilities/dependency-graph.ts:81:5 at new Promise (<anonymous>) at createDependencyGraph (/Users/trishta/src/github.com/Shopify/argo-checkout/scripts/typedoc/utilities/dependency-graph.ts:75:9) at extensionPoints (/Users/trishta/src/github.com/Shopify/argo-checkout/scripts/typedoc/shopify-dev-renderer/extension-points.ts:18:23) at renderForShopifyDev (/Users/trishta/src/github.com/Shopify/argo-checkout/scripts/typedoc/shopify-dev-renderer/index.ts:10:3) { errno: -2, syscall: 'open', code: 'ENOENT', path: '/Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts' }

More errors after cloning checkout-web

Can’t resolve export type `Record` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `StatefulRemoteSubscribable` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `StatefulRemoteSubscribable` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `StatefulRemoteSubscribable` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `StatefulRemoteSubscribable` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `Promise` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `Promise` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `Promise` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `StatefulRemoteSubscribable` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `StatefulRemoteSubscribable` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `StatefulRemoteSubscribable` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `Promise` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `Promise` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `StatefulRemoteSubscribable` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `Promise` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `AllComponents` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `Record` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `StatefulRemoteSubscribable` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `StatefulRemoteSubscribable` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `StatefulRemoteSubscribable` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `StatefulRemoteSubscribable` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `Promise` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `Promise` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `Promise` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `StatefulRemoteSubscribable` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `StatefulRemoteSubscribable` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `StatefulRemoteSubscribable` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `Promise` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `Promise` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `StatefulRemoteSubscribable` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `Promise` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `AllComponents` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `AllowedComponents` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `RemoteRoot` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `Input` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `Input` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `Input` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `Input` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `Partial` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package.

hm, you might need to yarn install in checkout-web?

I don't think we can/should clone repos automatically. i'll write a readme with these prereq steps.

I'm still seeing the type errors, are these expected?

TSTypeQuery is unhandled. ArrowFunctionExpression is unhandled. TSIndexedAccessType is unhandled. TSIndexedAccessType is unhandled. TSIndexedAccessType is unhandled. TSIndexedAccessType is unhandled. TSIndexedAccessType is unhandled. TSIndexedAccessType is unhandled. TSIndexedAccessType is unhandled. TSConditionalType is unhandled. TSConditionalType is unhandled. TSConditionalType is unhandled. TSTypeLiteral is unhandled. TSTypeLiteral is unhandled. TSTypeLiteral is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTypeLiteral is unhandled. TSTypeLiteral is unhandled. TSTypeLiteral is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. Can’t resolve export type `Record` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `StatefulRemoteSubscribable` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `StatefulRemoteSubscribable` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `StatefulRemoteSubscribable` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `StatefulRemoteSubscribable` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `Promise` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `Promise` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `Promise` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `StatefulRemoteSubscribable` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `StatefulRemoteSubscribable` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `StatefulRemoteSubscribable` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `Promise` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `Promise` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `StatefulRemoteSubscribable` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `Promise` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `AllComponents` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `Record` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `StatefulRemoteSubscribable` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `StatefulRemoteSubscribable` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `StatefulRemoteSubscribable` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `StatefulRemoteSubscribable` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `Promise` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `Promise` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `Promise` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `StatefulRemoteSubscribable` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `StatefulRemoteSubscribable` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `StatefulRemoteSubscribable` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `Promise` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `Promise` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `StatefulRemoteSubscribable` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `Promise` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `AllComponents` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `AllowedComponents` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `RemoteRoot` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `Input` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `Input` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `Input` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `Input` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `Partial` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package.

yes, they're expected, we are throwing these https://github.com/Shopify/argo-checkout/pull/70/files/0202003c242c338e73c97d1daea03cf24ff4e908#diff-b08df2e37da7db49e6cf3a91d88d8c459dde06173eafd476d770e275c5baf7e8R569-R571

this script is still WIP! I will need to handle some of these for the extension points, others we can safely ignore

Yep, this is to let us know where things are likely broken or not getting documented—both for typescript types and user defined types. Any "SomeType is unhandled" is a typescript feature we are using but the script does not yet support.

The unresolved errors are mostly for types imported from an external package that the script does not have access, too.

scripts/generate-docs-admin.ts

tsconfig.json

vividviolet

I finally got the scripts working but due to local issues I can't actually see the docs on shopify-dev so I couldn't fully top hat. The files look great though aside from the warnings

vividviolet · 2021-05-05T19:02:52Z

scripts/generate-docs-admin.ts

+    JavaScript: './packages/argo-admin',
+    React: './packages/argo-admin-react',
+  },
+  outputRoot: '../shopify-dev/content/tools/argo-admin',


Should we not put these docs in the same place as Checkout like docs/admin-extensions?

probably yes, haven't finalized this yet. not concerned about this right now.

vividviolet · 2021-05-05T19:03:51Z

scripts/typedoc/shopify-dev-renderer/index.ts

+
+export {extensionPoints, components, gettingStarted};
+
+export function renderForShopifyDev(paths: Paths) {


I'm still seeing the type errors, are these expected?

TSTypeQuery is unhandled. ArrowFunctionExpression is unhandled. TSIndexedAccessType is unhandled. TSIndexedAccessType is unhandled. TSIndexedAccessType is unhandled. TSIndexedAccessType is unhandled. TSIndexedAccessType is unhandled. TSIndexedAccessType is unhandled. TSIndexedAccessType is unhandled. TSConditionalType is unhandled. TSConditionalType is unhandled. TSConditionalType is unhandled. TSTypeLiteral is unhandled. TSTypeLiteral is unhandled. TSTypeLiteral is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTypeLiteral is unhandled. TSTypeLiteral is unhandled. TSTypeLiteral is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. TSTupleType is unhandled. Can’t resolve export type `Record` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `StatefulRemoteSubscribable` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `StatefulRemoteSubscribable` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `StatefulRemoteSubscribable` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `StatefulRemoteSubscribable` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `Promise` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `Promise` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `Promise` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `StatefulRemoteSubscribable` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `StatefulRemoteSubscribable` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `StatefulRemoteSubscribable` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `Promise` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `Promise` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `StatefulRemoteSubscribable` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `Promise` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `AllComponents` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `Record` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `StatefulRemoteSubscribable` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `StatefulRemoteSubscribable` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `StatefulRemoteSubscribable` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `StatefulRemoteSubscribable` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `Promise` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `Promise` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `Promise` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `StatefulRemoteSubscribable` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `StatefulRemoteSubscribable` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `StatefulRemoteSubscribable` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `Promise` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `Promise` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `StatefulRemoteSubscribable` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `Promise` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `AllComponents` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `AllowedComponents` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `RemoteRoot` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `Input` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `Input` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `Input` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `Input` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package. Can’t resolve export type `Partial` in /Users/trishta/src/github.com/Shopify/checkout-web/packages/argo-checkout/src/index.ts. Maybe it’s not exported from the component index or imported from a remote package.

iainmcampbell · 2021-05-05T19:26:39Z

🎉🎉🎉

vividviolet

Works great 👍

tmlayton force-pushed the extract-docs branch from 1aeeddc to 5543537 Compare April 5, 2021 18:27

iainmcampbell force-pushed the extract-docs branch 2 times, most recently from 823b1cb to 2b02b09 Compare April 28, 2021 20:53

tmlayton and others added 25 commits April 29, 2021 14:03

deps

1da1cac

Add script to generate READMEs

4ed814a

Co-authored-by: Tim Layton <[email protected]>

improve docs and add examples

ba24ed7

render js and react examples

98447d3

proper code formatting

b5247a9

fix void type

3cfaf56

support params

9945818

more types

874cdf6

updates for content and getting started

041d7fc

yamlFrontMatter function

b030433

Replace hardcoded paths in components()

0da5844

Genericize renderExamples

2e7ae4e

genericize getAdditionalContentFor, renaming

3b86bf2

typescript

722baba

Parse and output tsdoc tags in PropertySignature nodes

4e95c86

fix table formatting

532bd57

fix up doc content output

2ac9d4f

update taxonomy and more clean-up

2a8bb48

Wrap example code in {% raw %} so liquid doesn't barf

56eab05

Render additionalPropsTables with <h3>

9a95609

Sort components alphabetically

972a21a

Add yarn run docs command

650370b

Handle Responsive type

5555812

Cool that fixed View too

73336a0

fix linting

df01ecb

iainmcampbell force-pushed the extract-docs branch from 2b02b09 to df01ecb Compare April 29, 2021 18:03

iainmcampbell added 3 commits April 29, 2021 14:41

Add argo-admin generate-docs script entry

f0099b9

Add support for interface extends

cdadaf2

Move shopify dev renderer into own folder, begin to componentize

71d782b

iainmcampbell force-pushed the extract-docs branch from 796488e to 71d782b Compare April 29, 2021 21:32

add skipLibCheck to base tsconfig

45194bb

iainmcampbell marked this pull request as ready for review May 3, 2021 19:53

iainmcampbell requested review from vividviolet and lemonmade May 3, 2021 20:27

Scripts get its own tsconfig

c76b383

fix rendering bugs, output proper yaml frontmatter description

0202003

vividviolet reviewed May 4, 2021

View reviewed changes

iainmcampbell added 4 commits May 4, 2021 15:14

double quotes around yaml frontmatter description

7a84f77

move to repo tsconfig

8af05c7

fix resolve bug

3563335

Remove scripts tsconfig

fe402ce

vividviolet reviewed May 5, 2021

View reviewed changes

Replace showdown with markdown-table

82eaf78

iainmcampbell force-pushed the extract-docs branch from 3b72857 to 82eaf78 Compare May 5, 2021 19:23

vividviolet approved these changes May 5, 2021

View reviewed changes

iainmcampbell merged commit 505f7a6 into main May 5, 2021

iainmcampbell deleted the extract-docs branch May 5, 2021 20:05

iainmcampbell mentioned this pull request May 12, 2021

misc doc extraction rendering bugs #97

Merged


		export {extensionPoints, components, gettingStarted};

		export function renderForShopifyDev(paths: Paths) {

Extract docs #70

Extract docs #70

Uh oh!

Conversation

tmlayton commented Apr 5, 2021 • edited by iainmcampbell Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Todo

Content todo

Uh oh!

iainmcampbell commented Apr 29, 2021

Uh oh!

tmlayton commented Apr 29, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

iainmcampbell commented May 3, 2021

Uh oh!

tmlayton commented May 4, 2021

Uh oh!

iainmcampbell commented May 4, 2021

Uh oh!

vividviolet left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

vividviolet left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

iainmcampbell commented May 5, 2021

Uh oh!

vividviolet left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

tmlayton commented Apr 5, 2021 •

edited by iainmcampbell

Loading

tmlayton commented Apr 29, 2021 •

edited

Loading