diff --git a/README.md b/README.md index 42f21ddbfc..4353d1e2bf 100644 --- a/README.md +++ b/README.md @@ -17,8 +17,8 @@ **Note: you can find [the full documentation on the website](https://dartcodemetrics.dev/docs/getting-started/introduction)** [Configuration](https://dartcodemetrics.dev/docs/getting-started/configuration) | -[Rules](https://dartcodemetrics.dev/docs/rules/overview) | -[Metrics](https://dartcodemetrics.dev/docs/metrics/overview) | +[Rules](https://dartcodemetrics.dev/docs/rules) | +[Metrics](https://dartcodemetrics.dev/docs/metrics) | [Anti-patterns](https://dartcodemetrics.dev/docs/anti-patterns/overivew) @@ -31,13 +31,13 @@ Dart Code Metrics is a static analysis tool that helps you analyse and improve your code quality. -- Reports [code metrics](https://dartcodemetrics.dev/docs/metrics/overview) -- Provides [additional rules](https://dartcodemetrics.dev/docs/rules/overview) for the dart analyzer -- Checks for [anti-patterns](https://dartcodemetrics.dev/docs/anti-patterns/overview) +- Reports [code metrics](https://dartcodemetrics.dev/docs/metrics) +- Provides [additional rules](https://dartcodemetrics.dev/docs/rules) for the dart analyzer +- Checks for [anti-patterns](https://dartcodemetrics.dev/docs/anti-patterns) - Checks [unused `*.dart` files](https://dartcodemetrics.dev/docs/cli/check-unused-files) - Checks [unused l10n](https://dartcodemetrics.dev/docs/cli/check-unused-l10n) - Checks [unnecessary nullable parameters](https://dartcodemetrics.dev/docs/cli/check-unnecessary-nullable) -- Can be used as [CLI](https://dartcodemetrics.dev/docs/cli/overview), [analyzer plugin](https://dartcodemetrics.dev/docs/analyzer-plugin) or [library](https://dartcodemetrics.dev/docs/getting-started/installation#library) +- Can be used as [CLI](https://dartcodemetrics.dev/docs/cli), [analyzer plugin](https://dartcodemetrics.dev/docs/analyzer-plugin) or [library](https://dartcodemetrics.dev/docs/getting-started/installation#library) ## Links @@ -127,7 +127,7 @@ The package can be used as CLI and supports multiple commands: For additional help on any of the commands, enter `dart run dart_code_metrics:metrics help ` -**Note:** if you're setting up Dart Code Metrics for multi-package repository, check out [this website section](https://dartcodemetrics.dev/docs/cli/overview#multi-package-repositories-usage). +**Note:** if you're setting up Dart Code Metrics for multi-package repository, check out [this website section](https://dartcodemetrics.dev/docs/cli#multi-package-repositories-usage). #### Analyze diff --git a/website/docs/anti-patterns/overview.md b/website/docs/anti-patterns/index.md similarity index 60% rename from website/docs/anti-patterns/overview.md rename to website/docs/anti-patterns/index.md index d91e59e6a4..2326e398c5 100644 --- a/website/docs/anti-patterns/overview.md +++ b/website/docs/anti-patterns/index.md @@ -1,11 +1,6 @@ ---- -sidebar_position: 0 -sidebar_label: Overview ---- +# Anti-patterns -# Anti-patterns overview - -Anti-patterns configuration is [described here](../getting-started/configuration#configuring-an-anti-pattern-entry). +Anti-patterns configuration is [described here](./getting-started/configuration#configuring-an-anti-pattern-entry). Available anti-patterns: diff --git a/website/docs/cli/overview.md b/website/docs/cli/index.md similarity index 97% rename from website/docs/cli/overview.md rename to website/docs/cli/index.md index 497abc4e06..b2ff6ccb99 100644 --- a/website/docs/cli/overview.md +++ b/website/docs/cli/index.md @@ -1,9 +1,4 @@ ---- -sidebar_position: 0 -sidebar_label: 'Overview' ---- - -# CLI Overview +# CLI To use the package as a command-line tool, run diff --git a/website/docs/getting-started/installation.md b/website/docs/getting-started/installation.md index 0584117205..afec99640f 100644 --- a/website/docs/getting-started/installation.md +++ b/website/docs/getting-started/installation.md @@ -43,7 +43,7 @@ To use Dart Code Metrics as a plugin to the Dart analyzer refer to the [Analyzer ### CLI {#cli} -To use Dart Code Metrics as a command-line tool refer to the [Command Line Interface documentation section](../cli/overview.md). +To use Dart Code Metrics as a command-line tool refer to the [Command Line Interface documentation section](../cli). ### Library {#library} diff --git a/website/docs/metrics/overview.md b/website/docs/metrics/index.md similarity index 89% rename from website/docs/metrics/overview.md rename to website/docs/metrics/index.md index a7ad2fa9dd..0849a7f4e8 100644 --- a/website/docs/metrics/overview.md +++ b/website/docs/metrics/index.md @@ -1,18 +1,13 @@ ---- -sidebar_position: 0 -sidebar_label: Overview ---- - -# Metrics overview +# Metrics Metrics are grouped by a category to help you understand their purpose. -Metrics configuration is [described here](../getting-started/configuration#configuring-a-metrics-entry). +Metrics configuration is [described here](./getting-started/configuration#configuring-a-metrics-entry). ## Function specific metrics {#function-specific-metrics} - [Cyclomatic Complexity](./cyclomatic-complexity.md) - + The number of linearly-independent paths through a method. - [Halstead Volume](./halstead-volume.md) diff --git a/website/docs/rules/overview.mdx b/website/docs/rules/index.mdx similarity index 98% rename from website/docs/rules/overview.mdx rename to website/docs/rules/index.mdx index dfd8174f96..09bce735dc 100644 --- a/website/docs/rules/overview.mdx +++ b/website/docs/rules/index.mdx @@ -1,15 +1,10 @@ ---- -sidebar_label: Overview -sidebar_position: 0 ---- - import RuleEntry from '@site/src/components/RuleEntry'; -# Rules overview +# Rules :::tip -General rules configuration is [described here](../getting-started/configuration#configuring-a-rules-entry). +General rules configuration is [described here](./getting-started/configuration#configuring-a-rules-entry). ::: diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index 7b1dbb08a1..f2544e8128 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -42,22 +42,22 @@ module.exports = { activeBasePath: 'docs/getting-started', }, { - to: 'docs/rules/overview', + to: 'docs/rules', label: 'Rules', position: 'right', activeBasePath: 'docs/rules', }, { - to: 'docs/metrics/overview', + to: 'docs/metrics', label: 'Metrics', position: 'right', activeBasePath: 'docs/metrics', }, { - to: 'docs/cli/overview', + to: 'docs/cli', label: 'Commands', position: 'right', - activeBasePath: 'docs/cli/overview', + activeBasePath: 'docs/cli', }, { href: 'https://github.com/dart-code-checker/dart-code-metrics', @@ -74,11 +74,11 @@ module.exports = { items: [ { label: 'Rules', - to: 'docs/rules/overview', + to: 'docs/rules', }, { label: 'Metrics', - to: 'docs/metrics/overview', + to: 'docs/metrics', }, { label: 'Configuration', @@ -139,7 +139,8 @@ module.exports = { { docs: { sidebarPath: require.resolve('./sidebars.js'), - editUrl: 'https://github.com/dart-code-checker/dart-code-metrics/tree/master/website/', + editUrl: + 'https://github.com/dart-code-checker/dart-code-metrics/tree/master/website/', }, theme: { customCss: require.resolve('./src/css/custom.css'), diff --git a/website/src/components/RuleEntry.tsx b/website/src/components/RuleEntry.tsx index 47bda7829a..ecee596287 100644 --- a/website/src/components/RuleEntry.tsx +++ b/website/src/components/RuleEntry.tsx @@ -23,7 +23,7 @@ export default function RuleEntry({ hasFix, isDeprecated, }: Props) { - const href = `${type}/${name}`; + const href = `rules/${type}/${name}`; return (