Skip to content

Simplify readme documentation, link to docs site#89

Merged
andrewjensen merged 1 commit into
mainfrom
adj/consolidate-docs
Jun 10, 2026
Merged

Simplify readme documentation, link to docs site#89
andrewjensen merged 1 commit into
mainfrom
adj/consolidate-docs

Conversation

@andrewjensen

Copy link
Copy Markdown
Collaborator

This shortens the README.md file and links to our docs site. This way we can consolidate the bulk of our CLI docs in one spot.

Comment thread README.md
DX_WEB_BASE_URL="https://dx.some-example-subdomain.example.com" DX_API_BASE_URL="https://api.dx.some-example-subdomain.example.com" DX_API_TOKEN="$DX_TOKEN" dx auth status
```

## Logging

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Already on the docs site

Comment thread README.md
dx <subcommand> --help
```

### Customizing base URLs

@andrewjensen andrewjensen Jun 10, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moving to the docs site in another PR

Comment thread README.md
dx init
```

For CI, Docker/dev containers, or other headless environments, pass the token

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Already on the docs site

@andrewjensen andrewjensen merged commit f156426 into main Jun 10, 2026
4 checks passed
@andrewjensen andrewjensen deleted the adj/consolidate-docs branch June 10, 2026 23:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants