Getting started with imodel-transformer - #235
Conversation
derbynn
commented
Feb 11, 2025
derbynn
commented
- documentation to get started
|
|
||
| ## Overview | ||
|
|
||
| The repository supports both JavaScript and TypeScript. To build a strong foundation, check out these resources: |
There was a problem hiding this comment.
Is this section on TS/JS necessary?
There was a problem hiding this comment.
I included it because my intended audience was onboarders
There was a problem hiding this comment.
Understood, but if this is going in the transformer package docs, the audience is much larger.
| For more details on the transformer itself: | ||
|
|
||
| - **Transformer Repo:** [GitHub - imodel-transformer](https://github.com/iTwin/imodel-transformer) | ||
| - **Transformer Docs:** [iTwinJS Transformer Learning](https://www.itwinjs.org/learning/transformer) |
There was a problem hiding this comment.
Presumably this document is going into the docs - I don't think that a link to "Transformer Docs" makes sense.
There was a problem hiding this comment.
It seems to me that $docs is not an in-built thing in markdown file? I see that there are some other broken links is why there are also broken links in the existing transformer documentation - https://github.com/iTwin/imodel-transformer/blob/main/docs/learning/transformer/branching-imodels.md. Do the $docs tag only work when this markdown file is published to itwin.js org docs?
|
|
||
| - **Transformer Repo:** [GitHub - imodel-transformer](https://github.com/iTwin/imodel-transformer) | ||
| - **Transformer Docs:** [iTwinJS Transformer Learning](https://www.itwinjs.org/learning/transformer) | ||
| - **Branching & Synchronization:** [Branching iModels Documentation](https://github.com/iTwin/imodel-transformer/blob/main/docs/learning/transformer/branching-imodels.md) |
There was a problem hiding this comment.
This should be a relative link since the target exists within the trasnformer docs. You can use $docs to represent the root of the doc site (i.e. $docs/learning/trasnformer/branching-imodels.md).
| ## Key Concepts | ||
|
|
||
| - **Snapshot:** | ||
| A [static](https://www.itwinjs.org/learning/backend/accessingimodels/#snapshot-imodels) point-in-time representation of an iModel’s state. |
There was a problem hiding this comment.
See comment above about relative links and using $docs. There are several more instances in this document as well.
2 participants
