quarkiverse / quarkus-renarde

Server-side Web Framework with Qute templating, magic/easier controllers, auth, reverse-routing
Apache License 2.0
78 stars 19 forks source link

Nice doc with Nav :) #148

Closed ia3andy closed 1 year ago

ia3andy commented 1 year ago

Inspired by other extensions like:

image

@gastaldi I didn't find a way to test the nav locally

ia3andy commented 1 year ago

So, what exactly did you do to index? Just split it in two? The diffs don't show me what you did.

I:

FroMage commented 1 year ago

Why manual fragments instead of the auto-generated ones?

ia3andy commented 1 year ago

Why manual fragments instead of the auto-generated ones?

So they don't change if the title changes as they are referenced

FroMage commented 1 year ago

OK, very good point :)

ia3andy commented 1 year ago

@FroMage did you approve?

ia3andy commented 1 year ago

(we can always switch to auto-generated if that become something)

gastaldi commented 1 year ago

To test the nav locally I think you'd need to run Antora to generate the website by changing the Antora playbook to point to your repository/branch

FroMage commented 1 year ago

To test the nav locally I think you'd need to run Antora to generate the website by changing the Antora playbook to point to your repository/branch

Actually it's worse than this. Now my generated index.html page contains nothing and I can't navigate and see the rest of the docs locally before I push anything.

How do I test my docs locally now?

ia3andy commented 1 year ago

To test the nav locally I think you'd need to run Antora to generate the website by changing the Antora playbook to point to your repository/branch

Actually it's worse than this. Now my generated index.html page contains nothing and I can't navigate and see the rest of the docs locally before I push anything.

How do I test my docs locally now?

I thought I broke something but yeah I think we need to have some nav generated locally

It seems to be nice: https://docs.quarkiverse.io/quarkus-renarde/dev/index.html

FroMage commented 1 year ago

Yeah, it looks nice, on the surface, BUT… now I have two navs: one at the left which is missing deeper levels and is not generated, and one at the right which is missing higher levels but is generated.

This is really bad UI. How can we fix this?

gastaldi commented 1 year ago

Yeah, I agree. We should somehow adapt the local generation to use Antora and its layout (as it's built in quarkiverse-docs)

ia3andy commented 1 year ago

@gastaldi @FroMage

I don't think it's BAD UI, people tend to see things differently. Still I think we should have a common experience, let's continue the discussion there where @holly-cummins has already started some comparison with other docs: https://github.com/quarkiverse/quarkiverse-docs/issues/102#issuecomment-1640558021

ia3andy commented 1 year ago

@gastaldi for some reason the config reference is not working, I think it wasn't already before my change any thoughts?

gastaldi commented 1 year ago

@ia3andy I browsed the sources and didn't find any interface with @ConfigMapping or @ConfigRoot, what do you mean?

FroMage commented 1 year ago

I seem to have also lost the favicon I recently added :(