Dashboard: Add documentation sidebar #836
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Docmentation links may need an update. |
|
Are tooltips needed after this addition given that the documentation provides the same information as tooltips would? @ax3l |
proy30
changed the title
proy30
force-pushed
the
dashboard/add_documentation_sidebar
branch
from
7ee4303 to
1e277c8
Compare
proy30
changed the title
|
Niceee! I think I would still keep the tooltips for the individual fields, because it makes it easy to see what's going on and is a best practice. We can consider cropping the tooltips to the first line / first sentence we encounter in a doc string. |
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
proy30
force-pushed
the
dashboard/add_documentation_sidebar
branch
from
ca5a2d8 to
4729288
Compare
proy30
changed the title
|
@proy30 small conflict to resolve pls, due to tooltip merge 🙏 |
Instead of opening a new tab to the documentation when users click on the info button on a section header, the documentation is integrated onto the dashboard and is shown through a drawer style ui
still may be wrong link
Future pr needs to split up generalFunctions
proy30
force-pushed
the
dashboard/add_documentation_sidebar
branch
from
7fca5de to
f09f45b
Compare
for more information, see https://pre-commit.ci
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Documentation appears in a sidebar instead of opening in a new tab.
chrome_58vmgW3vIC.mp4
After #834 is merged, need to make some minor changes