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

[Draft]Add support for dynamic doc generation for Meshmodels #273

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

Revolyssup
Copy link
Contributor

Description

This PR fixes #

Notes for Reviewers

Signed commits

  • Yes, I signed my commits.

Signed-off-by: Ashish Tiwari <[email protected]>
Signed-off-by: Ashish Tiwari <[email protected]>
Signed-off-by: Ashish Tiwari <[email protected]>
@stale
Copy link

stale bot commented Apr 23, 2023

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the issue/stale Issue has not had any activity for an extended period of time label Apr 23, 2023
@theBeginner86 theBeginner86 added issue/willfix This issue will be worked on and removed issue/stale Issue has not had any activity for an extended period of time labels Apr 24, 2023
@leecalcote
Copy link
Member

Here's an example of what this capability can offer.

Screen.Recording.2023-07-19.at.12.17.42.PM.mov

@leecalcote leecalcote removed the request for review from deepakdinesh1123 July 25, 2023 19:16
@theBeginner86
Copy link
Member

theBeginner86 commented Sep 13, 2023

Proposal for the doc format (in JSON) for each component:

{
"count": number,
"doc": [
{"title": "....",
"description":  "....",
"url":  "....",
},
{"title": "....",
"description" "....",
"url" "....",
},
{...},
{...},
{"title": "....",
"description" "....",
"url" "....",
}
]}

Here number of array elements determines whether navigation button is to be shown or not.

// @leecalcote @MUzairS15

@leecalcote
Copy link
Member

@theBeginner86 is the idea that "description" is the same as "caption"?

@theBeginner86
Copy link
Member

@theBeginner86 is the idea that "description" is the same as "caption"?

yes, caption and description are the same thing. We can use either of them. 👍

@theBeginner86
Copy link
Member

{
"doc": [
{"title": "....",
"description":  "....",
"url":  "....",
"formatted": false
},
{"title": "....",
"description" "....",
"url" "....",
"formatted": false
},
{
"html": "..."
"formatted": true
},
{...},
{...},
{"title": "....",
"description" "....",
"url" "....",
}
]}

@leecalcote
Copy link
Member

I suppose that some of the implicit possible attributes are excluded from this "internal" consideration; e.g. registry deep link, Meshery docs link, Model website link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/models issue/willfix This issue will be worked on
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants