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.

angular.io guide content contains many documentation lint errors

See original GitHub issue

Description

When the guide content of angular.io is analyzed by the documentation lint tool, ~3/4 of the topic files in the guide directory contain lint errors that should be corrected as soon as practical.

Removing the lint errors from the documentation helps improve the documentation’s readability by correcting the current content. After the documentation topics are free of linting errors, we can incorporate documentation linting into the CI/CD process to maintain clean documentation content going forward.

Note that PRs for fixes related to this issue do not need to include every topic with a lint error. PRs for individual or several files are preferred.

How to help

  1. Review Contributing to Angular
  2. Install the documentation linter on your local development system and IDE
  3. Make sure you can build the angular.io site on your development system
  4. Find and fix a topic (repeat as often as you’d like)
    1. Open a topic from angular/angular/aio/content/guide
    2. Review the commit message format to use when committing your changes
    3. Review and correct the problems identified by the documentation linter
    4. Save and commit your updated topic.
  5. Submit a PR with your revisions

What is the affected URL?

many

Please provide the steps to reproduce the issue

With the documentation linter installed in an IDE, open a guide topic and notice the problems that the linter identifies.

Please provide the expected behavior vs the actual behavior you encountered

The documentation source code should not have any documentation linter errors, and ideally, it should not have any problems at all.

Please provide a screenshot if possible

N/A

Please provide the exception or error you saw

N/A

Is this a browser-specific issue? If so, please specify the device, browser, and version.

Not browser specific.

Issue Analytics

  • State:open
  • Created a year ago
  • Comments:9 (3 by maintainers)

github_iconTop GitHub Comments

1reaction
bilelfekicommented, Aug 22, 2022

@gkalpak it was my mistake.

And The error looks really strange because I am using nvm(node version manager) and then my cmd should run as an administrator so what I did is I run yarn setup as an admin but yarn docs-watch as a simple user.

Thanks a lot for your help, you give me the opportunity to stick to the problem and resolve it.

1reaction
gkalpakcommented, Aug 22, 2022

@bilelfeki, the versions look fine.

The error looks strange if yarn setup completed successfully. Is there an aio/content/cli-src/node_modules/ directory? Does it contain an @angular/cli/ directory?

It might be worth trying clearing the yarn cache first (with yarn cache clean) and then running yarn setup again.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Resolve documentation linter messages - Angular
A documentation linter message contains these elements. ... The lint tool tests against the styles found in these style guides. Most style tests...
Read more >
Angular coding style guide
Looking for an opinionated guide to Angular syntax, conventions, and application structure? Step right in. This style guide presents preferred conventions ...
Read more >
Cheat Sheet - Angular
Defines a module that contains components, directives, pipes, and providers. declarations: [ MyRedComponent, MyBlueComponent, MyDatePipe ]
Read more >
Angular documentation style guide
This style guide covers the standards for writing Angular documentation on angular.io. These standards ensure consistency in writing style, ...
Read more >
Template type checking - Angular
Just as TypeScript catches type errors in your code, Angular checks the expressions and bindings within the templates of your application and can...
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