question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

docs: linting section

See original GitHub issue

Thanks for this very cool tool 🎉

I am trying to set up custom linting rules and I found it a bit confusing, and I would like to provide feedback on the docs.

About the string-matcher property:

  • It does not seem to be published on https://docs.redoc.ly
  • I did not understand where to find the possible values for the on field, or how to compose the value.

On the website:

  • The https://docs.redoc.ly/cli/configuration/reference-docs/index.md link leads to a 404.

I’d be happy to send out a PR to update once we get answers here 🙂

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Comments:5 (4 by maintainers)

github_iconTop GitHub Comments

4reactions
adamaltmancommented, Jul 9, 2020

@ArtFlag we released a beta, as well as beta docs too.

0reactions
adamaltmancommented, Aug 26, 2020

We got some feedback on the docs that how-to guides would be helpful. I made one for a decorator:

https://redoc.ly/docs/resources/hide-apis/

However, I need to make one for a regular rule too.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Documentation as code: Part 2: A Linting How To - What tools ...
Documentation as code: Part 2: A Linting How To - What tools are out there and how do they work? - Tag1 TeamTalk...
Read more >
Linting and Formatting - SurviveJS
Text linting is less common than code linting but in large projects with many contributors it could improve documentation quality. You can: Validate...
Read more >
Linting policies | IAM Documentation - Google Cloud
This section shows you how to lint a condition expression using the Google Cloud console, Google Cloud CLI, or the REST API. To...
Read more >
Linting - MoodleDocs
PHP code is linted by PHP_CodeSniffer. The rules defined as part of the Code-checker plugin and if that plugin is installed to Moodle...
Read more >
Configuring ESLint - ESLint - Pluggable JavaScript Linter
Selecting a version will take you to the chosen version of the ESLint docs. ... Results will be shown and updated as you...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found