Markdown link validation issues [mdv]

[MikeRalphson]

My tool mdv spotted the following issues in README.md. I know that the spec. is a work-in-progress but thought it might be useful to highlight. mdv is in use by the OpenAPI spec, RAML, AsyncAPI and others. It can be run in a CI environment, feel free to let me know your preferred one and I can help set it up.

{ source: 'README.md',
  imagesWithMissingAlt: 1,
  missingAnchors:
   [ { name: 'serverObject',
       defined: 0,
       seen: 1,
       localRefNoHash: false },
     { name: 'runtime-expression',
       defined: 0,
       seen: 2,
       localRefNoHash: false },
     { name: 'errorObject',
       defined: 0,
       seen: 1,
       localRefNoHash: false },
     { name: 'externalDocumentationObject',
       defined: 0,
       seen: 1,
       localRefNoHash: false },
     { name: 'openrpcDocument',
       defined: 0,
       seen: 1,
       localRefNoHash: false },
     { name: 'infoVersion',
       defined: 0,
       seen: 1,
       localRefNoHash: false },
     { name: 'runtimeExpression',
       defined: 0,
       seen: 1,
       localRefNoHash: false } ],
  codeBlocksWithNoLanguage: 2,
  anchorsWithNoLinks:
   [ { name: 'openrpc-info', defined: 1, seen: 0, auto: false },
     { name: 'openrpc-methods', defined: 1, seen: 0, auto: false },
     { name: 'openrpc-components', defined: 1, seen: 0, auto: false },
     { name: 'openrpc-tags', defined: 1, seen: 0, auto: false },
     { name: 'openrpcExternalDocs', defined: 1, seen: 0, auto: false },
     { name: 'info-title', defined: 1, seen: 0, auto: false },
     { name: 'info-description', defined: 1, seen: 0, auto: false },
     { name: 'info-termsofservice', defined: 1, seen: 0, auto: false },
     { name: 'info-contact', defined: 1, seen: 0, auto: false },
     { name: 'info-license', defined: 1, seen: 0, auto: false },
     { name: 'info-version', defined: 1, seen: 0, auto: false },
     { name: 'contact-name', defined: 1, seen: 0, auto: false },
     { name: 'contact-url', defined: 1, seen: 0, auto: false },
     { name: 'contact-email', defined: 1, seen: 0, auto: false },
     { name: 'license-name', defined: 1, seen: 0, auto: false },
     { name: 'license-url', defined: 1, seen: 0, auto: false },
     { name: 'server-name', defined: 1, seen: 0, auto: false },
     { name: 'server-description', defined: 1, seen: 0, auto: false },
     { name: 'server-variables', defined: 1, seen: 0, auto: false },
     { name: 'server-variable-enum', defined: 1, seen: 0, auto: false },
     { name: 'server-variable-default',
       defined: 1,
       seen: 0,
       auto: false },
     { name: 'server-variable-description',
       defined: 1,
       seen: 0,
       auto: false },
     { name: 'method-name', defined: 1, seen: 0, auto: false },
     { name: 'method-tags', defined: 1, seen: 0, auto: false },
     { name: 'method-summary', defined: 1, seen: 0, auto: false },
     { name: 'method-description', defined: 1, seen: 0, auto: false },
     { name: 'method-externalDocs', defined: 1, seen: 0, auto: false },
     { name: 'method-parameters', defined: 1, seen: 0, auto: false },
     { name: 'method-result', defined: 1, seen: 0, auto: false },
     { name: 'method-deprecated', defined: 1, seen: 0, auto: false },
     { name: 'method-servers', defined: 1, seen: 0, auto: false },
     { name: 'method-errors', defined: 1, seen: 0, auto: false },
     { name: 'method-links', defined: 1, seen: 0, auto: false },
     { name: 'method-param-structure',
       defined: 1,
       seen: 0,
       auto: false },
     { name: 'content-descriptor-Summary',
       defined: 1,
       seen: 0,
       auto: false },
     { name: 'content-descriptor-description',
       defined: 1,
       seen: 0,
       auto: false },
     { name: 'content-descriptor-required',
       defined: 1,
       seen: 0,
       auto: false },
     { name: 'content-descriptor-schema',
       defined: 1,
       seen: 0,
       auto: false },
     { name: 'content-descriptor-examples',
       defined: 1,
       seen: 0,
       auto: false },
     { name: 'content-descriptor-deprecated',
       defined: 1,
       seen: 0,
       auto: false },
     { name: 'example-name', defined: 1, seen: 0, auto: false },
     { name: 'example-summary', defined: 1, seen: 0, auto: false },
     { name: 'example-description', defined: 1, seen: 0, auto: false },
     { name: 'example-value', defined: 1, seen: 0, auto: false },
     { name: 'example-externalValue',
       defined: 1,
       seen: 0,
       auto: false },
     { name: 'link-method', defined: 1, seen: 0, auto: false },
     { name: 'link-parameters', defined: 1, seen: 0, auto: false },
     { name: 'link-description', defined: 1, seen: 0, auto: false },
     { name: 'link-server', defined: 1, seen: 0, auto: false },
     { name: 'error-code', defined: 1, seen: 0, auto: false },
     { name: 'error-message', defined: 1, seen: 0, auto: false },
     { name: 'error-data', defined: 1, seen: 0, auto: false },
     { name: 'components-content-descriptors',
       defined: 1,
       seen: 0,
       auto: false },
     { name: 'components-schemas', defined: 1, seen: 0, auto: false },
     { name: 'components-examples', defined: 1, seen: 0, auto: false },
     { name: 'components-links', defined: 1, seen: 0, auto: false },
     { name: 'components-errors', defined: 1, seen: 0, auto: false },
     { name: 'tag-name', defined: 1, seen: 0, auto: false },
     { name: 'tag-description', defined: 1, seen: 0, auto: false },
     { name: 'tag-externalDocs', defined: 1, seen: 0, auto: false },
     { name: 'external-doc-description',
       defined: 1,
       seen: 0,
       auto: false },
     { name: 'external-doc-url', defined: 1, seen: 0, auto: false },
     { name: 'reference-ref', defined: 1, seen: 0, auto: false },
     { name: 'info-extensions', defined: 1, seen: 0, auto: false } ] }

[shanejonas]

@MikeRalphson great, should definitely be useful. Thanks for taking your time to look at the repo and show us this tool. 👍

[BelfordZ]

AWESOME! Thank you @MikeRalphson!

We are currently in the process of setting up circle ci for our tooling. I was actually just 'shopping' for some ideas on CI/CD for the spec, so I can't tell you how well timed this feedback is!!

Is there anything you need from me to make it happen?

[MikeRalphson]

Glad the timing was fortuitous!

Is there anything you need from me to make it happen?

No I don't think so, ping me when Circle CI is up (e.g. with an empty job) and I can PR the necessary changes.

[MikeRalphson]

Also, if when you want to make the project more visible (e.g. searchable by default) pinging GitHub support to 'unfork' the project may be an idea, that way you don't lose stars/issues etc.

[BelfordZ]

should be all set now!