Skip to content

Commit 0aca62b

Browse files
committed
docs: cleaning
1 parent 3df32d1 commit 0aca62b

File tree

20 files changed

+214
-288
lines changed

20 files changed

+214
-288
lines changed

assets/cli-help.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

assets/linters-info.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/gatsby-config.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ module.exports = {
1616
siteAuthor: `@golangci`,
1717
siteImage: `/logo.png`,
1818
siteLanguage: `en`,
19-
themeColor: `#7159c1`,
19+
themeColor: `#59c1ce`,
2020
basePath,
2121
footer: ${new Date().getFullYear()}`,
2222
},

docs/src/@rocketseat/gatsby-theme-docs/src/components/Docs/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import React from 'react';
22
import PropTypes from 'prop-types';
3-
import { MDXRenderer } from 'gatsby-plugin-mdx';
3+
import {MDXRenderer} from 'gatsby-plugin-mdx';
44

55
import Layout from '../Layout';
66
import SEO from '../SEO';

docs/src/@rocketseat/gatsby-theme-docs/src/styles/global.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import React from 'react';
2-
import { Global, css, useTheme } from '@emotion/react';
3-
import { lighten } from 'polished';
2+
import {css, Global, useTheme} from '@emotion/react';
3+
import {lighten} from 'polished';
44

55
export default function GlobalStyle() {
66
const theme = useTheme();
@@ -53,7 +53,7 @@ export default function GlobalStyle() {
5353
h4,
5454
h5,
5555
h6 {
56-
color: #737380;
56+
color: #4f4f58;
5757
margin: 24px 0 16px 0;
5858
font-weight: normal;
5959
}
@@ -71,7 +71,7 @@ export default function GlobalStyle() {
7171
vertical-align: middle;
7272
line-height: 1;
7373
padding: 0.2em 0.2em 0.3em 0.2em;
74-
background-color: #44475a;
74+
background-color: #575b73;
7575
color: rgba(248, 248, 242);
7676
font-size: 14px;
7777
border-radius: 3px;

docs/src/@rocketseat/gatsby-theme-docs/src/styles/theme.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
export default {
22
colors: {
3-
primary: '#7159c1',
3+
primary: '#59c1ce',
44
background: '#fff',
55
sidebar: {
66
background: '#ffffff',

docs/src/config/sidebar.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,6 @@
3434
link: "/product/migration-guide/"
3535
- label: "Roadmap"
3636
link: "/product/roadmap/"
37-
- label: "Performance"
38-
link: "/product/performance/"
3937
- label: "GitHub"
4038
link: "https://github.com/golangci/golangci-lint"
4139
- label: "Contributing"

docs/src/docs/contributing/architecture.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: Architecture
55

66
import ResponsiveContainer from "components/ResponsiveContainer";
77

8-
There are the following `golangci-lint` execution steps:
8+
There are the following golangci-lint execution steps:
99

1010
<ResponsiveContainer>
1111

@@ -138,7 +138,7 @@ Currently, all linters except `unused` can be merged into this meta linter.
138138
The `unused` isn't merged because it has high memory usage.
139139

140140
Linters execution starts in `runAnalyzers`.
141-
It's the most complex part of the `golangci-lint`.
141+
It's the most complex part of the golangci-lint.
142142
We use custom [go/analysis](https://pkg.go.dev/golang.org/x/tools/go/analysis) runner there.
143143
It runs as much as it can in parallel. It lazy-loads as much as it can to reduce memory usage.
144144
Also, it sets all heavyweight data to `nil` as becomes unneeded to save memory.

docs/src/docs/contributing/workflow.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ By participating in this project, you agree to abide our [code of conduct](https
88

99
## Set up your machine
1010

11-
`golangci-lint` is written in [Go](https://go.dev).
11+
Golangci-lint is written in [Go](https://go.dev).
1212

1313
Prerequisites:
1414

@@ -40,21 +40,21 @@ Add your new or updated parameters to `.golangci.next.reference.yml` so they wil
4040

4141
## Submit a pull request
4242

43-
Push your branch to your `golangci-lint` fork and open a pull request against the
43+
Push your branch to your golangci-lint fork and open a pull request against the
4444
`main` branch.
4545

4646
## Pull request checks
4747

4848
First, please, accept [CLA](https://gist.github.com/jirfag/26a39fd375da84b2d5ad4296fecb0668) - [CLA assistant](https://cla-assistant.io/) will make a comment on the pull request about it.
4949

50-
Also, we run a few checks in CI by using GitHub Actions, you can see them [here](https://github.com/golangci/golangci-lint/blob/HEAD/.github/workflows/pr.yml).
50+
Also, we run a few checks in CI by using GitHub Actions, you can see them [here](https://github.com/golangci/golangci-lint/blob/HEAD/.github/workflows).
5151

5252
## New releases
5353

5454
First, see [our versioning policy](/product/roadmap/#versioning-policy).
5555

5656
To make a new release create a tag `vx.y.z`. Don't forget to add zero patch version for a new minor release, e.g. `v1.99.0`.
57-
A GitHub Action [workflow](https://github.com/golangci/golangci-lint/blob/HEAD/.github/workflows/tag.yml) will start building and publishing release after that.
57+
A GitHub Action [workflow](https://github.com/golangci/golangci-lint/blob/HEAD/.github/workflows/release.yml) will start building and publishing release after that.
5858

5959
After making a release you need to update
6060
GitHub [Action config](https://github.com/golangci/golangci-lint/blob/HEAD/assets/github-action-config.json) by running:

docs/src/docs/index.mdx

Lines changed: 14 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -5,27 +5,16 @@ title: Introduction
55
import { FaSlack } from "react-icons/fa";
66
import { IconContainer } from "lib/icons";
77

8-
[![License](https://img.shields.io/github/license/golangci/golangci-lint)](https://github.com/golangci/golangci-lint/blob/HEAD/LICENSE)
9-
[![Release](https://img.shields.io/github/release/golangci/golangci-lint.svg)](https://github.com/golangci/golangci-lint/releases/latest)
10-
[![Docker](https://img.shields.io/docker/pulls/golangci/golangci-lint)](https://hub.docker.com/r/golangci/golangci-lint)
11-
[![GitHub Releases Stats of golangci-lint](https://img.shields.io/github/downloads/golangci/golangci-lint/total.svg?logo=github)](https://somsubhra.github.io/github-release-stats/?username=golangci&repository=golangci-lint)
12-
13-
`golangci-lint` is a fast linters runner for Go.
8+
Golangci-lint is a fast linters runner for Go.
149

1510
It runs linters in parallel, uses caching, supports YAML configuration,
1611
integrates with all major IDEs, and includes over a hundred linters.
1712

18-
Join our Slack <IconContainer color="#1DA1F2"><FaSlack /></IconContainer> channel by [joining Gophers workspace](https://invite.slack.golangbridge.org/)
19-
and then [joining](https://gophers.slack.com/archives/CS0TBRKPC) channel [`#golangci-lint`](https://gophers.slack.com/archives/CS0TBRKPC).
20-
21-
Follow the news and releases:
22-
23-
[![Follow on Mastodon](https://img.shields.io/badge/mastodon-6364FF?style=for-the-badge&logo=mastodon&logoColor=white)](https://fosstodon.org/@golangcilint)
24-
[![Follow on Twitter](https://img.shields.io/badge/twitter-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white)](https://twitter.com/golangci)
13+
![golangci-lint demo](./demo.gif)
2514

2615
## Features
2716

28-
-[Very fast](/product/performance): runs linters in parallel, reuses Go build cache and caches analysis results.
17+
-Fast: runs linters in parallel, reuses Go build cache and caches analysis results.
2918
- ⚙️ YAML-based [configuration](/usage/configuration).
3019
- 🖥 [Integrations](/welcome/integrations) with VS Code, Sublime Text, GoLand, GNU Emacs, Vim, GitHub Actions.
3120
- 🥇 [A lot of linters](/usage/linters) included, no need to install them.
@@ -36,19 +25,24 @@ Follow the news and releases:
3625

3726
## Supporting Us
3827

28+
Golangci-lint is a free and open-source project built by volunteers.
29+
30+
If you value it, consider supporting us, we appreciate it! ❤️
31+
3932
[![Open Collective backers and sponsors](https://img.shields.io/opencollective/all/golangci-lint?logo=opencollective&style=for-the-badge)](https://opencollective.com/golangci-lint)
4033
[![GitHub Sponsors](https://img.shields.io/github/sponsors/golangci?logo=github&style=for-the-badge)](https://github.com/sponsors/golangci)
4134
[![Linter Authors](https://img.shields.io/badge/Linter-Authors-blue?style=for-the-badge)](https://golangci-lint.run/product/thanks/)
4235

43-
`golangci-lint` is a free and open-source project built by volunteers.
44-
45-
If you value it, consider supporting us, we appreciate it! ❤️
36+
## Social Networks
4637

47-
## Demo
38+
Join our Slack <IconContainer color="#1DA1F2"><FaSlack /></IconContainer> channel by [joining Gophers workspace](https://invite.slack.golangbridge.org/)
39+
and then [joining](https://gophers.slack.com/archives/CS0TBRKPC) channel [#golangci-lint](https://gophers.slack.com/archives/CS0TBRKPC).
4840

49-
![golangci-lint demo](./demo.gif)
41+
Follow the news and releases:
5042

51-
[Get started now!](/welcome/install)
43+
[![Follow on Mastodon](https://img.shields.io/badge/mastodon-6364FF?style=for-the-badge&logo=mastodon&logoColor=white)](https://fosstodon.org/@golangcilint)
44+
[![Follow on Bluesky](https://img.shields.io/badge/bluesky-0a7aff?style=for-the-badge&logo=bluesky&logoColor=white)](https://fosstodon.org/@golangcilint)
45+
[![Follow on Twitter](https://img.shields.io/badge/twitter-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white)](https://twitter.com/golangci)
5246

5347
## Contributors
5448

0 commit comments

Comments
 (0)