Docs: Low-Priority: unclear explanation for the usage of hyphens.

Open
#481 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
docker-compose
Domain
documentation

Research direction

Start with docs/knowledge-base/docker/compose.md around lines 172–176 and compare the explanation of underscores and hyphens with its example. Clarify the rule so the prose and example agree; it is done when readers can tell exactly when a hyphen replacement is required.

Written by the indexing model from the issue text.

Description

https://github.com/coollabsio/coolify-docs/blob/922c18e38a3397836513e402ac52d410505b9107/docs/knowledge-base/docker/compose.md?plain=1#L172-L176

This reads like "All _ are banned" while example shows "All _ are okay but one has to be replaced with - maybe?"

Dominant language
MDX
Stars
381
Forks
338
Avg merge
16h 54m
Merged PRs (30d)
11

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from coollabsio/coolify-docs

All issues in coollabsio/coolify-docs

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.