Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added Tutorials to Docs #7095

Merged
merged 8 commits into from
May 25, 2023
Merged

Added Tutorials to Docs #7095

merged 8 commits into from
May 25, 2023

Conversation

hotzenklotz
Copy link
Member

@hotzenklotz hotzenklotz commented May 23, 2023

I added two of the extended tutorials from Medium to the docs:

I uploaded the videos assets to S3

This PR requires an update the video plugins for mkdocs in the libs repo. scalableminds/webknossos-libs#905

URL of deployed dev instance (used for testing):

  • https://___.webknossos.xyz

Steps to test:

  • Generate docs from wk-libs repo
  • Read the docs

Issues:

  • None

(Please delete unneeded items, merge only when none are left open)

Copy link
Member

@daniel-wer daniel-wer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, I mainly added comment for some minor issues. I wasn't able to render the docs to check the result, because of the poetry version issue (see scalableminds/webknossos-libs#905 (comment))

docs/getting_started.md Outdated Show resolved Hide resolved
docs/sharing.md Outdated
Comment on lines 179 to 206
},
mappingInfo?: {
mappingName: string,
mappingType: MappingType,
agglomerateIdsToImport?: Array<number>,
},
connectomeInfo?: {
connectomeName: string,
agglomerateIdsToImport?: Array<number>,
},
isDisabled?: boolean,
},
};

type UrlManagerState = {|
position?: Vector3,
mode?: ViewMode,
zoomStep?: number,
activeNode?: number,
rotation?: Vector3,
stateByLayer?: UrlStateByLayer,
|};

```
type BaseMeshUrlDescriptor = {|
+segmentId: number,
+seedPosition: Vector3,
|};
type AdHocMeshUrlDescriptor = {|
...BaseMeshUrlDescriptor,
+isPrecomputed: false,
mappingName: ?string,
mappingType: ?MappingType,
|};
type PrecomputedMeshUrlDescriptor = {|
...BaseMeshUrlDescriptor,
+isPrecomputed: true,
meshFileName: string,
|};
type MeshUrlDescriptor = AdHocMeshUrlDescriptor | PrecomputedMeshUrlDescriptor;

type UrlStateByLayer = {
[layerName: string]: {
meshInfo?: {
meshFileName: ?string,
meshes: Array<MeshUrlDescriptor>,
},
mappingInfo?: {
mappingName: string,
mappingType: MappingType,
agglomerateIdsToImport?: Array<number>,
},
connectomeInfo?: {
connectomeName: string,
agglomerateIdsToImport?: Array<number>,
},
isDisabled?: boolean,
},
};

type UrlManagerState = {|
position?: Vector3,
mode?: ViewMode,
zoomStep?: number,
activeNode?: number,
rotation?: Vector3,
stateByLayer?: UrlStateByLayer,
|};

```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be reverted, looks like your auto-formatter simply removed all indentation 🤷

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reverted

docs/tutorial_volume_annotation.md Show resolved Hide resolved
docs/tutorial_volume_annotation.md Outdated Show resolved Hide resolved
docs/tutorial_volume_annotation.md Show resolved Hide resolved
docs/tutorial_volume_annotation.md Outdated Show resolved Hide resolved
docs/tutorial_data_sharing.md Outdated Show resolved Hide resolved
Copy link
Member

@daniel-wer daniel-wer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, only one more suggestion due to today's blog post update.

docs/tutorial_volume_annotation.md Outdated Show resolved Hide resolved
@hotzenklotz hotzenklotz enabled auto-merge (squash) May 25, 2023 12:08
@hotzenklotz hotzenklotz merged commit b8a48fb into master May 25, 2023
@hotzenklotz hotzenklotz deleted the tutorials branch May 25, 2023 12:25
hotzenklotz added a commit that referenced this pull request May 31, 2023
…ty-list-drawings

* 'master' of github.com:scalableminds/webknossos:
  [Docs] Update embedded YouTube URLs (#7102)
  Show organization in dataset info tab (#7087)
  Added Tutorials to Docs (#7095)
  Combine both download modals into one (#7068)
  Add "merge" blend mode (#6936)
  Changed the spacing/width of VX reports runs selection (#7094)
  Allow dataset managers to see all workflow reports of their orga (#7081)
  Fix rectangle at 0,0,0 (#7088)
  Allow to disable automatic reloading of meshes during proofreading (#7076)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants