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

Improvements to Code Node Explained Page #985

Open
iskerrett opened this issue Jul 19, 2023 · 4 comments · Fixed by #1145
Open

Improvements to Code Node Explained Page #985

iskerrett opened this issue Jul 19, 2023 · 4 comments · Fixed by #1145
Labels
task A piece of work that isn't necessarily tied to a specific Epic or Story.

Comments

@iskerrett
Copy link
Contributor

Description

I really like the Core Nodes pages. I would like to suggest some improvements:

  1. For the Left hand navigation it would be nice to have this list to be expandable. At the top level should be: Common, Function, Network, Parsers, Sequence, Storage. Each one of these the user should be able to expand to see the next level.
  2. I would like to use the title 'Node-RED Core Nodes Explained'
  3. For the introductory text, it would be nice to for each section description include a link to the section in the left hand side and expand it out.
  4. I would move the search bar to the top of the left hand side.

Epic/Story

No response

Have you provided an initial effort estimate for this issue?

I have provided an initial effort estimate

@iskerrett iskerrett added the task A piece of work that isn't necessarily tied to a specific Epic or Story. label Jul 19, 2023
@joepavitt
Copy link
Contributor

I would move the search bar to the top of the left hand side.

Just a note to say, the Core Nodes currently use the same templating as the Handbook & Docs, so if we move the search bar to top-left for Core Nodes, it would also move on the Handbook and Docs too. This was top-left originally, but believe @ZJvandeWeg moved it fairly recently.

@joepavitt
Copy link
Contributor

joepavitt commented Jul 21, 2023

For the Left hand navigation it would be nice to have this list to be expandable.

Couple of options here, currently, this template is built such that the red titles aren't collapsable, but their children can be. An easy "fix" for this, would be to structure the folders and md files such that there are folders for common, etc. and then the nodes live inside those folders, as we do in the docs/handbook e.g. https://flowforge.com/handbook/

Alternatively, if we do want to have the red sections collapsable, that'll be a little trickier, but would be possible. The sections are driven by the navGroup property in the front matter, and that's just a plain string. These groups don't necessarily have any data for themselves, e.g. whether they could be collapsable. If we want to add this, we can, but would require similar data structure added as we did in #955 which allowed for control over the ordering of these groups.

@iskerrett
Copy link
Contributor Author

If we are using the same template as the documentation and handbook, then can't we just just the expandable format we use in the documentation and handbook?

@joepavitt
Copy link
Contributor

yep - that was my explanation here: #985 (comment)

@Yndira-E Yndira-E linked a pull request Sep 27, 2023 that will close this issue
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
task A piece of work that isn't necessarily tied to a specific Epic or Story.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants