Skip to content

docs(cli): add docs images #476

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
BioPhoton merged 5 commits into from
Feb 8, 2024
Merged

docs(cli): add docs images #476

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
136355a
docs(cli): add images
BioPhoton Feb 7, 2024
6c5ee7d
docs(cli): format
BioPhoton Feb 7, 2024
868afd1
docs(cli): add links
BioPhoton Feb 7, 2024
842908f
docs(cli): add shields
BioPhoton Feb 7, 2024
9469ce4
docs: add coverage plugin link
BioPhoton Feb 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,5 +27,6 @@ This monorepo contains code for open-source Code PushUp NPM packages:
- [🧩 @code-pushup/utils](./packages/utils#readme) - various **utilities** (useful for custom plugins or other integrations)
- plugins:
- [📦 @code-pushup/eslint-plugin](./packages/plugin-eslint#readme) - static analysis using **ESLint** rules
- [📦 @code-pushup/coverage-plugin](./packages/plugin-coverage#readme) - code coverage analysis

If you want to contribute, please refer to [CONTRIBUTING.md](./CONTRIBUTING.md).
7 changes: 4 additions & 3 deletions packages/cli/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,10 @@

---

| 📊 Getting Started | 🌐 Portal Integration | 🛠️ CI Automation |
| :--------------------------------------------------: | :------------------------------------------------: | :----------------------------------------: |
| **[How to setup](#getting-started)** a basic project | Sort, filter **[your goals](#portal-integration)** | Updates **[on every PR](#-ci-automation)** |
| 📊 Getting Started | 🌐 Portal Integration | 🛠️ CI Automation |
| :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------: |
| **[How to setup](#getting-started)** a basic project | Sort, filter **[your goals](#portal-integration)** | Updates **[on every PR](#-ci-automation)** |
| <a href="#getting-started"><img alt="Getting started cover image" title="Getting started with code-pushup" src="./docs/images/getting-started-cover.png" max-height="200" width="auto"></a> | <a href="#portal-integration"><img alt="Portal integration cover image" title="Inetegrate code-pushup portal" src="./docs/images/portal-cover.png" max-height="200" width="auto"></a> | <a href="#-ci-automation"><img alt="CI Automation cover" title="CI automation guide" src="./docs/images/cli-cover.png" max-height="200" width="auto"></a> |

---

Expand Down
Binary file added packages/cli/docs/images/cli-cover.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added packages/cli/docs/images/getting-started-cover.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added packages/cli/docs/images/portal-cover.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion packages/plugin-coverage/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# @code-pushup/coverage-plugin
# @code-pushup/coverage-plugin [![npm](https://img.shields.io/npm/v/%40code-pushup%2Fcoverage-plugin.svg)](https://www.npmjs.com/package/%40code-pushup%2Fcoverage-plugin)

🧪 **Code PushUp plugin for tracking code coverage.** ☂️

Expand Down
2 changes: 1 addition & 1 deletion packages/plugin-eslint/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# @code-pushup/eslint-plugin [![npm](https://img.shields.io/npm/v/%40code-pushup%2Fplugin-eslint.svg)](https://www.npmjs.com/package/%40code-pushup%2Fplugin-eslint)
# @code-pushup/eslint-plugin [![npm](https://img.shields.io/npm/v/%40code-pushup%2Feslint-plugin.svg)](https://www.npmjs.com/package/%40code-pushup%2Feslint-plugin)

🕵️ **Code PushUp plugin for detecting problems in source code using ESLint.** 📋

Expand Down
2 changes: 1 addition & 1 deletion packages/plugin-lighthouse/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# @code-pushup/lighthouse-plugin
# @code-pushup/lighthouse-plugin [![npm](https://img.shields.io/npm/v/%40code-pushup%2Flighthouse-plugin.svg)](https://www.npmjs.com/package/%40code-pushup%2Flighthouse-plugin)

TODO: docs