Editorial policy

Clear technical guidance requires visible editorial standards.

This policy explains how LinearCli.com selects sources, checks technical claims, presents commands, handles updates and protects its independence.

Purpose and scope

Documentation is written to help users complete real tasks.

LinearCli.com covers Linear CLI installation, authentication, configuration, commands, workflows, integrations, comparisons and troubleshooting.

Content should explain what a command does, what it requires, what result the user should expect and which limitations may affect the outcome.

Core principle: Never ask a user to copy a command without providing enough context to understand its purpose.

Source standards

Primary sources come before summaries

Technical claims are stronger when they can be checked against the source that defines the feature or command.

Preferred

Primary technical sources

  • Official product documentation
  • Official or maintained software repositories
  • Command help output and configuration references
  • Release notes and project changelogs

These sources are used first when confirming syntax, supported features and current behavior.

Supporting

Secondary context

  • Maintainer discussions
  • Verified technical examples
  • Issue reports that reveal real limitations
  • Reliable explanations of surrounding tools

Secondary sources can provide context but should not replace available primary documentation.

Excluded

Unsupported material

  • Unverified command examples
  • Anonymous claims without evidence
  • Automatically generated facts without checking
  • Copied descriptions that add no user value

Unsupported material is not treated as reliable technical evidence.

Verification process

Every command needs more than correct spelling

A useful command example must include syntax, prerequisites, context and a realistic expected result.

Syntax

Confirm the command

Check the command name, subcommand, flags, arguments and example values.

Requirements

Identify prerequisites

State whether installation, authentication, configuration, Git or another tool is required.

Context

Explain where it runs

Clarify whether the command should run globally, inside a repository or from a configured project.

Result

Describe the outcome

Tell users what a successful result should look like and what to check when it fails.

Content presentation

Clarity, safety and user control

Technical accuracy is important, but the information must also be readable and safe to follow.

Use plain language

Explain unfamiliar terms before relying on them in instructions.

Separate commands from explanation

Commands appear in clear code blocks so users can distinguish executable text from supporting content.

Label example values

Placeholder issue IDs, workspace names and project values should not be mistaken for universal settings.

Show limitations

Dependencies, permission requirements and unsupported environments should be visible.

Protect credentials

API keys, access tokens and private workspace information must never be requested by this website.

Updates and maintenance

Technical content changes when software changes

Pages should be reviewed when meaningful changes affect commands, installation methods, authentication or user outcomes.

A command is added, removed or renamed.

An installation method or requirement changes.

Authentication or credential handling changes.

A documented workflow produces a different result.

A material factual or safety issue is identified.

LinearCli.com does not label a page as “latest” merely because a year has changed. Update wording should reflect an actual content review.

Corrections

Material errors should be corrected clearly.

When a factual, technical or safety-related error is identified, the affected instruction should be checked against reliable sources and corrected.

  1. Confirm that the reported or discovered problem is real.
  2. Identify every page where the same information appears.
  3. Replace the incorrect instruction or add the missing limitation.
  4. Review nearby internal links, examples and structured data for consistency.
Independence and transparency

Editorial wording must not imply official status

Independent documentation should make its relationship to the products it discusses immediately understandable.

Independent identity

LinearCli.com is not affiliated with or endorsed by Linear or the developer of the Linear CLI software.

No hidden account access

This website does not connect to a Linear workspace, execute commands or receive API keys.

Commercial transparency

Any future sponsorship or commercial relationship that could affect user interpretation should be clearly labelled.

AI-assisted work

AI tools may assist with organization or drafting, but their output is not treated as a technical source and should be checked before publication.

Important limitation

Documentation cannot know every local environment.

Operating systems, shells, package managers, permissions, repository settings and software versions can change a command’s result. Users should review commands before running them and protect their own credentials and data.

Continue with the reference

Learn more about the website or browse its guides.

Review the purpose of LinearCli.com or continue to practical command documentation.