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

docsgen: #568

Open
jkowalleck opened this issue Jan 9, 2025 · 0 comments
Open

docsgen: #568

jkowalleck opened this issue Jan 9, 2025 · 0 comments
Assignees

Comments

@jkowalleck
Copy link
Member

jkowalleck commented Jan 9, 2025

context

current docsgen produce the following structure:

XML-SCHEMA-DOCUMENTATION
+---1.0
|       index.html
|
+---1.1
|       index.html
|
+---1.2
|       index.html
|
+---1.3
|       index.html
|
+---1.4
|       index.html
|
+---1.5
|       index.html
|
\---1.6
        index.html

but for the website we need it in the following format:

.../public/docs
+---1.0
|   \---xml
|           index.html
|
+---1.1
|   \---xml
|           index.html
|
+---1.2
|   +---json
|   |       index.html
|   |       schema_doc.css
|   |       schema_doc.min.js
|   |
|   \---xml
|           index.html
|
+---1.3
|   +---json
|   |       index.html
|   |       schema_doc.css
|   |       schema_doc.min.js
|   |
|   \---xml
|           index.html
|
+---1.4
|   +---json
|   |       index.html
|   |       schema_doc.css
|   |       schema_doc.min.js
|   |
|   \---xml
|           index.html
|
+---1.5
|   +---json
|   |       index.html
|   |       schema_doc.css
|   |       schema_doc.min.js
|   |
|   \---xml
|           index.html
|
\---1.6
    +---json
    |       index.html
    |       schema_doc.css
    |       schema_doc.min.js
    |
    \---xml
            index.html

issue

Since the structures from docgen and the website are not similar, it is simply impossible to copy the one into the other right away ...
Each folder needs to be copied separately and into another different folder. This is tedious and error-prone.

goal

This ticket's goal is to make the resulting structure from the docsgen more copy/past-friendly for the website.

At best, i can download the docgen artifacts and copy-paste tem directly into .../public/docs and be good to go.

expected outcome

docsgen produce the following structure:

some-SCHEMA-DOCUMENTATION
+---1.1
|   +---json || xml || proto
|       some-files
=
|
\---1.6
    +---json || xml || proto
            some-files

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

1 participant