Skip to content
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.

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

docs: organize sections and pages #4493

Merged
merged 10 commits into from
Mar 14, 2024
Merged

Conversation

ldez
Copy link
Member

@ldez ldez commented Mar 13, 2024

Just a bit a reorganisation of the pages of the documentation.

  • Split "Usage" section into a "Welcome" section and a "Usage" section.
  • Move "Performance" page into the "Product" section.
  • Split "Roadmap" page into a "Roadmap" page and a "Changelog" page.
  • Change the order of the questions in the FAQ.
  • Move version policy and deprecation cycle from "Install" to "Roadmap".
  • Remove disabled linters from "Quick Start"
Sidebar Before
.
├── Introduction
├── Usage
│   ├── Install
│   ├── Quick Start
│   ├── Integrations
│   ├── Linters
│   ├── Configuration
│   ├── False Positives
│   ├── Performance
│   └── FAQ
├── Product
│   ├── Roadmap
│   ├── Thanks
│   ├── Trusted By
│   └── GitHub
├── Contributing
│   ├── Quick Start
│   ├── Workflow
│   ├── Architecture
│   ├── New Linters
│   ├── Debug
│   ├── FAQ
│   └── This Website
└── Plugins
    ├── Module Plugin System
    └── Go Plugin System
Screenshot Before

Screenshot Sidebar Before

Sidebar After
.
├── Introduction
├── Welcome
│   ├── Install
│   ├── Quick Start
│   ├── Integrations
│   └── FAQ
├── Usage
│   ├── Configuration
│   ├── Linters
│   └── False Positives
├── Product
│   ├── Thanks
│   ├── Trusted By
│   ├── Changelog
│   ├── Roadmap
│   ├── Performance
│   └── GitHub
├── Contributing
│   ├── Quick Start
│   ├── Workflow
│   ├── Architecture
│   ├── New Linters
│   ├── Debug
│   ├── FAQ
│   └── This Website
└── Plugins
    ├── Module Plugin System
    └── Go Plugin System
Screenshot After

Screenshot Sidebar After

FAQ TOC Before

Screenshot TOC FAQ Before

FAQ TOC After

Screenshot TOC FAQ After

@ldez ldez added enhancement New feature or improvement area: docs labels Mar 13, 2024
@ldez ldez added this to the next milestone Mar 13, 2024
@ldez ldez requested review from alexandear and bombsimon March 13, 2024 01:02
@ldez ldez force-pushed the feat/docs-organize branch from 1bcd94e to a46631c Compare March 13, 2024 14:33
docs/src/config/sidebar.yml Show resolved Hide resolved
docs/src/docs/usage/faq.mdx Outdated Show resolved Hide resolved
@ldez
Copy link
Member Author

ldez commented Mar 14, 2024

@bombsimon do you have an opinion on this one?

Copy link
Member

@bombsimon bombsimon left a comment

Choose a reason for hiding this comment

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

LGTM! No strong feelings for this but might want to not put too much effort into the web page if we hope to get to a replacement in the somewhat near future.

This is a nice short term change though! 👍🏼

@ldez ldez merged commit d736d09 into golangci:master Mar 14, 2024
12 checks passed
@ldez ldez deleted the feat/docs-organize branch March 14, 2024 23:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: docs enhancement New feature or improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants