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

[FEATURE]: Separate static site for 'Additional-Documentation' #1421

Open
Vislesha opened this issue Dec 11, 2023 · 1 comment
Open

[FEATURE]: Separate static site for 'Additional-Documentation' #1421

Vislesha opened this issue Dec 11, 2023 · 1 comment
Assignees

Comments

@Vislesha
Copy link

Vislesha commented Dec 11, 2023

Team:

Can we have a feature where we can prepare a separate stand-lone site for "Additional Documentation" with it's own index.html and other assets?

We have been using mkdocs python library to generate our application user guide and embedding it into our final dist build. Being a python library, it has to reside on its own repo and manual effort to build and integrate into our final build as a post process step.

"compodoc" is a wonderful library which can be used to streamline the application user guide generation from the actual angular project itself!

I am wondering if its possible to generate this user-guide as a separate stand-alone site (without application's technical documentation) that can be generated with a configuration switch.

Thanks!

PS: Couple of additional requests are: make the content rendering panel responsive so that it can adjust to the viewport. Also, header and footer sections with previous and next buttons to navigate documentation.

@Vislesha Vislesha changed the title [FEATURE]: Separate site for 'Additional-Documentation' [FEATURE]: Separate stand-alone site for 'Additional-Documentation' Dec 11, 2023
@Vislesha
Copy link
Author

Hi Team: any tentative timeline for this feature to be included in the library?

@Vislesha Vislesha changed the title [FEATURE]: Separate stand-alone site for 'Additional-Documentation' [FEATURE]: Separate static site for 'Additional-Documentation' Apr 9, 2024
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