Skip to content

Add basic Nutshell example for experimentation #256

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

Closed
wants to merge 3 commits into from

Conversation

nrichers
Copy link
Collaborator

@nrichers nrichers commented Jul 18, 2024

Internal Notes for Reviewers

This PR does exactly one thing: it provides a working Nutshell example that can be used to experiment with a better alternative for step 1 in task topics. @noosheenv @validbeck

Includes:

  • A step-1.qmd file with text for the Nutshell bubble (dependency on Add Private Service Connect & rework login info #251 to render variables, FYI)
  • A modified guide/configuration/managing-your-organization.qmd task topic that demonstrates how to use the Nutshell bubble
  • Some initial style modifications in styles.css (hide the text with the source, hide the icon, pink links, smaller bubble radius) — more is needed

Note that tables don't seem to render correctly.

2024-07-17_19-31-46 (1)

External Release Notes

@nrichers nrichers added DO NOT MERGE PR is not ready to be merged internal Not to be externalized in the release notes labels Jul 18, 2024
@validbeck
Copy link
Collaborator

validbeck commented Jul 30, 2024

Some initial thoughts:

  • If we do end up using the Nutshell extension, I'd recommend a top-level folder in site to the effect of nutshell and then naming the file/instruction with the contents instead of a floating unclear step-1.qmd etc.
  • We might also want to change the whole instruction to a variable e.g.[:Log in to ValidMind](/nutshell/login.qmd#x-step-1).
  • I was able to get the table to perform a bit better with some non-breaking spaces, but the solution isn't ideal...
  • The little dots animation prefacing the "link" seems to be baked into the JS file, and I'm sure we could modify it (perhaps to 3 lines of defense, converging into a checkmark on hover...?) but it does seem sort of juvenile overall in contrast to the rest of the site.

Screenshot 2024-07-30 at 10 04 41 AM

Overall, after playing with it, and on consideration of "less links in the instructions and simpler is better for both author and user," I think I'd rather us resurrect a Log in to ValidMind guide that is linked in the Prerequisites section of each relevant page.

  • For example, we have a "You are logged into the ValidMind Platform UI" list item already in some articles such as Collaborate with others. EDIT: It looks like this line was removed when we added the login page, but here is what it used to look like:
Screenshot 2024-08-01 at 10 40 46 AM
  • This would greatly cut down on the loginloginlogin links on pages with many sets of instructions, and allow us to update one central page with less fuss re: login instructions.
Example option one Example option two
Screenshot 2024-08-01 at 1 00 49 PM Screenshot 2024-08-01 at 2 07 57 PM

I personally prefer option two, and that allows us to make it a simple variable instead of an include as well!

@nrichers
Copy link
Collaborator Author

Closing — while we liked what Nutshell could do, it's not quite what we are looking for. This work will feed into a redesigned "Prerequisites" section as proposed by @validbeck instead.

@nrichers nrichers closed this Aug 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
DO NOT MERGE PR is not ready to be merged internal Not to be externalized in the release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants