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

Display documentation root in navigation #1181

Open
mtrefethen-m opened this issue Feb 21, 2025 · 2 comments
Open

Display documentation root in navigation #1181

mtrefethen-m opened this issue Feb 21, 2025 · 2 comments

Comments

@mtrefethen-m
Copy link

Use Case

Viewing the initial root documentation Root and then select a service Orders there is no visible method to get back to the root document without selecting a different main navigation option and then back to "Documentation".

Proposed Solution

Add a root "Catalog" or something in the Documentation sub-navigation to allow users to click back to to the main /pages/index.md root.

Implementation Notes

No response

Community Notes

  • Please vote by adding a 👍 reaction to the issue to help us prioritize.
  • If you are interested to work on this issue, please leave a comment.
  • If this issue is labeled needs-discussion, it means the spec has not been finalized yet. Please reach out in the EventCatalog Discord.
@mtrefethen-m
Copy link
Author

Now that I consider the issue more, it would be nice to have a way to build navigation and md documents at that level in general. Custom pages and navigation elements at the root of the documentation tree. I have documentation that crosses all domains, i.e authentication, contribution guides, service design guidelines, etc.

@boyney123
Copy link
Collaborator

Hey @mtrefethen-m

Yeah we have an idea to add custom pages for EventCatalog (https://discord.com/channels/918092420338569216/1304042250589966376), which will let you add what ever pages, groups, that you like. Currently on the roadmap, but it would help you do exactly what you want to see!

Implementation details are still to be discovered, but I do like the idea of just having docs in the file system and have them represented like you said. Docusuarus do a great job at this too, which I think we might follow suit of there format/api.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants