Skip to content

Improve documentation for website development #9797

Open
@ihhub

Description

@ihhub

Preliminary checks

Describe the problem requiring a solution

After reading the documentation I noticed that there are some moments that developers might find not clear so it is important to make the documentation as clear as possible.

Describe the possible solution

This is a list of improvements we can do:

  • specify required / recommended version for each tool or package. Only Ruby has this
  • a developer on macOS doesn't need to install innoextract so running brew bundle --file=script/macos/Brewfile.dev_tools makes not sense. We should replace this command with brew "clang-format" and specify why we need this. Later in the document we run npm based linter, so do we even need clang-format?
  • we should replace command git add . with git add docs as a web developer will work only within docs directory. This reduces the risk of committing unwanted changes
  • should we use a link to the official Jekyll installation rather than explaining how to set it up for a single OS?

Additional info

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationStuff related to documentationimprovementNew feature, request or improvement

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions