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.

Sign up for GitHub

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

Jump to bottom

Improve documentation panel #8135

Open
2 of 4 tasks
vitvakatu opened this issue Oct 23, 2023 · 5 comments
Open
2 of 4 tasks

Improve documentation panel #8135

vitvakatu opened this issue Oct 23, 2023 · 5 comments
Labels
-gui p-low Low priority

Comments

@vitvakatu
Copy link
Contributor

vitvakatu commented Oct 23, 2023 •
edited by farmaazon
Loading

Make the documentation panel better than the previous one.

  • Tags as in the new design (different colors, sorting, collapsing, custom rendering)
  • Examples as in the design (buttons instead of code samples)
  • Hide private entries
  • Protection against XSS attacks because of v-html
@vitvakatu vitvakatu added -gui p-low Low priority labels Oct 23, 2023
@vitvakatu vitvakatu removed this from Issues Board Oct 23, 2023
@vitvakatu vitvakatu moved this from ❓New to 📤 Backlog in Issues Board Oct 23, 2023
@somebody1234
Copy link
Contributor

Protection against XSS attacks because of v-html

I'd imagine rehype-sanitize would be sufficient for this

@vitvakatu vitvakatu self-assigned this Dec 11, 2023
@vitvakatu vitvakatu moved this from 📤 Backlog to 🔧 Implementation in Issues Board Dec 11, 2023
@vitvakatu vitvakatu mentioned this issue Dec 13, 2023
Merged
5 tasks
@vitvakatu vitvakatu moved this from 🔧 Implementation to 👁️ Code review in Issues Board Dec 13, 2023
mergify bot pushed a commit that referenced this issue Dec 15, 2023
@vitvakatu
Doc panel improvements (#8530)
41cb4e3 
Fixes parts of #8135

- Fixed rendering of the documentation panel when no entry is selected.
- Multiple improvements of tags in the documentation panel:
- Group color for `GROUP` tag
- Custom styling for `DEPRECATED`, `UNSTABLE`, and `ADVANCED` tags.
- Sorting
- Collapsing tags that exceed one line with a button
- Filtering out some tags (`ICON` and `TEXT_ONLY` for now)
- Filtering out private items from the documentation
- Fixing group colors (was incorrectly assuming unique group names) and fallback color (was incorrectly replacing every character in the name with `-` before hashing, which was hilarious).
- Fixing ComponentBrowser demo scene.
- Minor fixes for mock database in demo scenes (removed duplicated entry, added an additional one for testing tags)


https://github.com/enso-org/enso/assets/6566674/10f4f5d0-9332-40c6-93c6-8263eb5fd85a
@farmaazon farmaazon moved this from 👁️ Code review to 📤 Backlog in Issues Board Dec 15, 2023
@enso-bot
Copy link

enso-bot bot commented Jan 17, 2024

Ilya Bogdanov reports a new STANDUP for the provided date (2023-12-11):

Progress: Starting working on improving doc panel. Fixed the demo scene, adjusted mocked suggestion database used there. Various minor fixes. It should be finished by 2023-12-15.

@enso-bot
Copy link

enso-bot bot commented Jan 17, 2024

Ilya Bogdanov reports a new STANDUP for the provided date (2023-12-12):

Progress: Custom rendering and other improvements for tags rendering in docs panel. Implementing tags collapsing when they exceed the line length. It should be finished by 2023-12-15.

@enso-bot
Copy link

enso-bot bot commented Jan 17, 2024

Ilya Bogdanov reports a new STANDUP for the provided date (2023-12-13):

Progress: The implementation was finished, and a PR was opened. It should be finished by 2023-12-15.

@enso-bot
Copy link

enso-bot bot commented Jan 17, 2024

Ilya Bogdanov reports a new STANDUP for the provided date (2023-12-14):

Progress: Addressing review comments. It should be finished by 2023-12-15.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
-gui p-low Low priority
Projects
Issues Board
Status: 📤 Backlog
Milestone
No milestone
Development

No branches or pull requests
2 participants
@somebody1234 @vitvakatu