Skip to content

angular.io guide content contains many documentation lint errors #47179

@bob-watson

Description

@bob-watson

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    P2The issue is important to a large percentage of users, with a workaroundgood first issueLabel noting a good first issue to be worked on by a community memberopen for contributionsAn issue that is suitable for a community contributor (based on its complexity/scope).

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions