Skip to content

feat: inline documentation in app#144

Closed
cedstrom wants to merge 1 commit intoav:mainfrom
cedstrom:rocm
Closed

feat: inline documentation in app#144
cedstrom wants to merge 1 commit intoav:mainfrom
cedstrom:rocm

Conversation

@cedstrom
Copy link
Copy Markdown
Contributor

@cedstrom cedstrom commented Mar 13, 2025

Enables optional inline documentation on the ServiceList page. It does this by parsing the markup for the associated wiki page and looking for text in the #### Overview section and then stops when it hits either another header or a separator.

Kooha-2025-03-13-00-02-28.webm

@cedstrom
Copy link
Copy Markdown
Contributor Author

The one downside of this is that it assume harbor is installed under your home directory, due to the way I have to parse paths to make Tauri restrictions happy. This is the same problem that plagues the profiles page. If we're okay with the restriction for now, I can also fix the profiles page, but I have yet to figure out how to get Tauri to be more permissive. It seems like the ** double-glob isn't supported for marking recursive paths in the capabilities.json file and you have base it on one of the Tauri BaseDirectories as I do here.

@av
Copy link
Copy Markdown
Owner

av commented Mar 15, 2025

Firstly, thank you so much! I'm very grateful for such an awesome contribution, and huge kudos for figuring things out on your own.


Secondly, as you probably guessed, including docs in the main repo source was a step towards having in-app docs. However, I wanted to approach this feature in a slightly different way than presented in this PR. My plan for the future was to add a dedicated "details" page for the services that'd include:

  • Wiki entry in its entirety
  • Actions to quickly open service config/workspace in the File Manager
  • Ability to adjust service-specific config and set env vars
  • Same actions as available on the service card right now
  • [Possibly] Iframe view for services with web address

As you might guess - it means a slightly different approach than used in the PR and a slightly bigger code area.


As for something that's more closely aligned with the visuals here - I wanted to include explainer tooltips to the service cards, with the content identical to what could be seen in the service index. As you can imagine - duplicating/copying these would quickly fall out of sync, so I wanted to start sourcing that index wiki page from the serviceMetadata.ts in the app sources (or source both from another shared location).

I can't ask you to work on any of the above features, and I'm grateful to you for spending the time with this code/project at all.

But If you'd still like to contribute - above ideas could be something that is more aligned for the planned features for the Harbor App.

Thank you!

@av
Copy link
Copy Markdown
Owner

av commented Mar 15, 2025

Ok, your PR inspired me to implement the latter portion about tooltips + service index generation. I've also made the app displaying actual service names instead of handles now:
image

Service details page is a larger effort though, I'm unlikely to approach it any time soon

@cedstrom
Copy link
Copy Markdown
Contributor Author

This all makes sense and I think we could actually reuse a lot of the file and presentation stuff from this PR. I'll give it a shot here soon when I get some free time. Can we convert this PR into a discussion so we can continue to refine the UX in a public forum or would you rather just close it?

@av
Copy link
Copy Markdown
Owner

av commented Mar 22, 2025

Sadly there's no wat to convert a PR, only an Issue, but here's a new discussion to proceed in:
#149

@av
Copy link
Copy Markdown
Owner

av commented Mar 23, 2025

v0.3.5 includes a few more steps towards these features

@av
Copy link
Copy Markdown
Owner

av commented Mar 24, 2025

Alright, I think it's time to close this PR now

I wanted to say thanks, again, for inspiring me to finally proceed with these features! We can talk more in #149 if needed

@av av closed this Mar 24, 2025
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.

2 participants