Skip to content

Update documentation#1151

Merged
subdavis merged 10 commits into
mainfrom
housekeeping/docs-updates
Feb 28, 2022
Merged

Update documentation#1151
subdavis merged 10 commits into
mainfrom
housekeeping/docs-updates

Conversation

@subdavis
Copy link
Copy Markdown
Contributor

@subdavis subdavis commented Feb 3, 2022

fixes #1148

blocked by #1147

@subdavis
Copy link
Copy Markdown
Contributor Author

I'd like some early feedback on a couple of concepts. I'm publishing drafts of the new docs here: https://subdavis.com/dive/

There's sort of a common theme here, which is that I want this site to do a bit more "marketing" work while being easier to use as a reference guide and easier for us to maintain.

  • I've switched to black because the old blue accent is not used anywhere in our app and clashes badly. Black makes our brand colors (Kitware blue/green and VIAME blue) stand out.
  • I've included the new Kitware logo and VIAME logo. This change alone I think makes the site look more professional and polished.
  • I've reorganized the navbar a bit into "Topics" so that it's clear what documentation belongs to what interested party. Documentation for end-users has been clearly separated from documentation for administrators. The FAQ was pulled out, as was the pipeline/training guide because I think it's a very important feature that sets us apart from other similar software, so I wanted to prominently feature it.
  • I was wrong yesterday about unifying the quickstart and UI docs. These serve clear purposes, and both are useful.
  • I'm trying to use fewer screenshots and better text formatting with material icons in some places. Screenshots are costly to update and I think in some cases, well-formatted text is actually just as helpful. For example:

@BryonLewis
Copy link
Copy Markdown
Collaborator

I'd like some early feedback on a couple of concepts. I'm publishing drafts of the new docs here: https://subdavis.com/dive/

I like the bar at the top. The Support Menu is a little weird because it takes the user further down in the page which immediately hides the top menu. All the other links reference the top of the page so the menu is still visible.

  • The kitware logo on the main screen looks fuzzy (maybe just to me). Specifically the text below the icon. This image has a high enough resolution, maybe it's just how it's downscaled or drawn?

These are probably best left for eventual review but I didn't want to forget.:

  • In the sharing descriptions there is no reference to tell them to "include subfolders" anymore?
  • On export for web we may want to provide a link to what a VIAME.csv is, we provide a link to DIVE Configuration specification.
  • Cloning datasets might want to talk about the fact that deleting the source will orphan the clones?

@marySalvi
Copy link
Copy Markdown
Collaborator

I like the bar at the top. The Support Menu is a little weird because it takes the user further down in the page which immediately hides the top menu. All the other links reference the top of the page so the menu is still visible.

I agree that the support menu is a little weird for the same reason. In addition I think the text next to the Kitware Logo should change to the selected 'Topic', not the first Heading in said topic.

For example this would be 'User Guide' instead of home:
Screenshot from 2022-02-23 12-52-06

@subdavis subdavis marked this pull request as ready for review February 24, 2022 19:10
@BryonLewis BryonLewis self-requested a review February 24, 2022 19:13
@subdavis
Copy link
Copy Markdown
Contributor Author

Ready for review, staging site is up to date: https://subdavis.com/dive/

The Support Menu is a little weird

Support page has been recreated, definitely need some feedback there.

The kitware logo on the main screen looks fuzzy (maybe just to me)

Rescaled, does this look better?

In the sharing descriptions there is no reference to tell them to "include subfolders" anymore?

it's still there

On export for web we may want to provide a link to what a VIAME.csv is, we provide a link to DIVE Configuration specification.

Done

Cloning datasets might want to talk about the fact that deleting the source will orphan the clones?

Done

I think the text next to the Kitware Logo should change to the selected 'Topic', not the first Heading in said topic.

This is how mkdocs works, I'm not aware that this is something we can customize.

Copy link
Copy Markdown
Collaborator

@BryonLewis BryonLewis left a comment

Choose a reason for hiding this comment

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

The logo thing is probably just how I view the scaling the kitware logo on the main page. I'm sure it's fine.

Thanks for going through and taking all these new screenshots and updating all the documentation. Most of my changes are comments/questions so feel free to mark them as resolved if you don't feel it is necessary.

Comment thread docs/Annotation-QuickStart.md Outdated
Comment thread docs/Command-Line-Tools.md
Comment thread docs/DataFormats.md
Comment thread docs/Dive-Desktop.md Outdated
Comment thread docs/Dive-Desktop.md Outdated
Comment thread docs/UI-Navigation-Editing-Bar.md
Comment thread docs/UI-Track-List.md Outdated
Comment thread docs/UI-Type-List.md Outdated
Comment thread docs/Web-Version.md Outdated
Comment thread docs/index.md Outdated
BryonLewis
BryonLewis previously approved these changes Feb 25, 2022
Copy link
Copy Markdown
Collaborator

@BryonLewis BryonLewis left a comment

Choose a reason for hiding this comment

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

Looks good, thanks for doing this.

@subdavis subdavis merged commit 2423078 into main Feb 28, 2022
@subdavis subdavis deleted the housekeeping/docs-updates branch February 28, 2022 14:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update documentation Feb 2022

3 participants