Skip to content

Information on running docs locally should be more visible #10169

Description

@zspriggs

Location

No response

Type

  • Text
  • Image or Gif
  • Other

Suggested content

There are no instructions for how to run the docs site locally in our documentation. This is a problem if someone is trying to contribute to docs and wants to validate their changes. The only place this information is recorded is in a README in the docs package, which is not very discoverable and does not mention the important fact that the API docs must be generated in order to run the Docusaurus site locally.

This info could be added to the Contribute to core page, but it might be better as its own short document about making contributions to docs.

Additional context

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    status: triageIssues awaiting triage by a Blockly team member

    Type

    No type

    Projects

    Status
    Todo

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions