Auto docs test #29
Auto docs test #29
Conversation
❌ Failed to deploy staticPlease check the workflow logs for details. |
|
We need an extensive docs on how to use this in README, e.g. how to generate, how to translate, how to pull changes from testplane repo, how to include or exclude certain class from generation |
|
Is that right that there are no manual edits in this, everything is auto-generated? e.g. if we remove the whole directory and run generate again, it all will be the same? |
|
Nice to have: is it possible to move this from left sidebar to the separate API tab in header? (like pwt does) I suspect this is how to do it — https://docusaurus.io/docs/docs-multi-instance, but not 100% sure. Just check if it's easy to pull off, if not, then it can be done later. |
Yes, but it is with some local changes in testplane typing exports |
There was a problem hiding this comment.
Nice to have: is it possible to group all error classes in one group in the left sidebar?
| | `currImg` | `public` | [`ImageInfo`](../interfaces/ImageInfo.mdx) | - | `BaseStateError.currImg` | [src/browser/commands/assert-view/errors/base-state-error.ts:4](https://github.com/gemini-testing/testplane/blob/57d0b182c37e21d8bdf52acbb137a028841767af/src/browser/commands/assert-view/errors/base-state-error.ts#L4) | | ||
| | `diffBounds?` | `public` | `CoordBounds` | - | - | [src/browser/commands/assert-view/errors/image-diff-error.ts:43](https://github.com/gemini-testing/testplane/blob/57d0b182c37e21d8bdf52acbb137a028841767af/src/browser/commands/assert-view/errors/image-diff-error.ts#L43) | | ||
| | `diffBuffer` | `public` | `Buffer` | - | - | [src/browser/commands/assert-view/errors/image-diff-error.ts:45](https://github.com/gemini-testing/testplane/blob/57d0b182c37e21d8bdf52acbb137a028841767af/src/browser/commands/assert-view/errors/image-diff-error.ts#L45) | | ||
| | `diffClusters?` | `public` | `CoordBounds`[] | - | - | [src/browser/commands/assert-view/errors/image-diff-error.ts:44](https://github.com/gemini-testing/testplane/blob/57d0b182c37e21d8bdf52acbb137a028841767af/src/browser/commands/assert-view/errors/image-diff-error.ts#L44) | |
There was a problem hiding this comment.
Types are now formatted as string|string[], is it possible to make them string | string[] ?
Makes them hard to read, IMO:
| @@ -0,0 +1,83 @@ | |||
| [testplane](../README.mdx) / WorkerEventHandler | |||
|
|
|||
| # Type Alias: WorkerEventHandler()\<T\> | |||
There was a problem hiding this comment.
Needs fix: Something very weird is going on here. This page should either be deleted or fixed
| # Type Alias: MasterEventHandler()\<T\> | ||
|
|
||
| ```ts | ||
| type MasterEventHandler<T>: (event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T(event, callback) => T; |
There was a problem hiding this comment.
Needs fix: Something very weird is going on here. This page should either be deleted or fixed
| | `assertViewOpts` | [`AssertViewOptsConfig`](../interfaces/AssertViewOptsConfig.mdx) | [`CommonConfig`](../interfaces/CommonConfig.mdx).`assertViewOpts` | [src/config/types.ts:136](https://github.com/gemini-testing/testplane/blob/57d0b182c37e21d8bdf52acbb137a028841767af/src/config/types.ts#L136) | | ||
| | `automationProtocol` | `"webdriver"` \| `"devtools"` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`automationProtocol` | [src/config/types.ts:97](https://github.com/gemini-testing/testplane/blob/57d0b182c37e21d8bdf52acbb137a028841767af/src/config/types.ts#L97) | | ||
| | `baseUrl` | `string` | [`CommonConfig`](../interfaces/CommonConfig.mdx).`baseUrl` | [src/config/types.ts:104](https://github.com/gemini-testing/testplane/blob/57d0b182c37e21d8bdf52acbb137a028841767af/src/config/types.ts#L104) | | ||
| | `browsers` | `Record`\<`string`, `BrowserConfig`\> | - | [src/config/types.ts:213](https://github.com/gemini-testing/testplane/blob/57d0b182c37e21d8bdf52acbb137a028841767af/src/config/types.ts#L213) | |
There was a problem hiding this comment.
BrowserConfig is referenced here, yet there is no definition. How is this resolved in general?
There was a problem hiding this comment.
Not sure how is this different from AssertViewOpts. Probably can be removed.
|
|
||
| | Property | Type | Default value | Description | Inherited from | Defined in | | ||
| | ------ | ------ | ------ | ------ | ------ | ------ | | ||
| | `allowViewportOverflow?` | `boolean` | `false` | Disables check that element is outside of the viewport left, top, right or bottom bounds. **Remarks** By default Testplane throws an error if element is outside the viewport bounds. This option disables check that element is outside of the viewport left, top, right or bottom bounds. And in this case if browser option [https://github.com/gemini-testing/testplane#compositeimage compositeImage](https://github.com/gemini-testing/testplane#compositeimage) set to `false`, then only visible part of the element will be captured. But if [https://github.com/gemini-testing/testplane#compositeimage compositeImage](https://github.com/gemini-testing/testplane#compositeimage) set to `true` (default), then in the resulting screenshot will appear the whole element with not visible parts outside of the bottom bounds of viewport. | `Partial.allowViewportOverflow` | [src/config/types.ts:45](https://github.com/gemini-testing/testplane/blob/57d0b182c37e21d8bdf52acbb137a028841767af/src/config/types.ts#L45) | |
There was a problem hiding this comment.
Nice to have: is it possible to split it into multiple lines? Because now it's quite hard to read, when it all is on one line.
| "gitRemote": "origin", | ||
|
|
||
| "locales": { | ||
| "ru": { |
There was a problem hiding this comment.
Hmm I don't think this works: https://testplane-ci.website.yandexcloud.net/testplane-docs/website-static/10404486960-127-1/docs/v8/api-reference/interfaces/CommandHistory/
I still see english headings there. That said, I'm not sure it's worth translating every heading. For instance, any of us would be quite puzzled reading "Сигнатура получения" as opposed to get signature. So, maybe it's worth tranlating some of them where it makes sense, like Class -> Класс or Variable -> Переменная, but where it makes it harder to read maybe it's worth keeping the original?
No description provided.