Add documentation button #57
Conversation
Add a new optional property 'docsUrl' to the index schema that allows to set the documentation's url. In case it isn't used, the readme is automatically linked. If the readme does not exist, the repo url is linked.
FilipZajdel
changed the title
FilipZajdel
requested review from
greg-fer,
bencefr,
datenreisender and
AliceMadama
There was a problem hiding this comment.
Nice addition!
Will the button wording and icon change if it is linking to the add-on's repository instead of a README or docs? Having "Documentation" and its icon for the pure repo link might suggest the docs are missing by mistake, which might not be the case -- their lack could be intentional.
| @@ -120,6 +120,10 @@ export const appMetadataSchema = { | |||
| type: 'string', | |||
| description: 'The default git branch that the repository is checked out. Inferred from the repo if missing.' | |||
| }, | |||
| docsUrl: { | |||
| type: 'string', | |||
| description: `The url of the addon's documentation` | |||
There was a problem hiding this comment.
| description: `The url of the addon's documentation` | |
| description: `The URL of the add-on's documentation` |
There was a problem hiding this comment.
Looks good to me. Will let @greg-fer also give his input as well
I added the link to the repo as the last resort fallback in case there is neither docsUrl nor README. If that's confusing I suggest hiding the button completely. What do you think? |
Sounds good! |
Add a new optional property 'docsUrl' to the index schema that allows to set the documentation's url. In case it isn't used, the readme is automatically linked. If the readme does not exist, the repo url is linked.
Also add the link for Thingy 91X documentation.
VSC-2602
VSC-2776