Skip to content

Commit d357cf0

Browse files
claudiacodacyclaude
andcommitted
docs: reduce tabbed navigation to Documentation and Release notes
Scale the tabs down to two: Documentation (the existing nav, unchanged) and Release notes (release notes plus special thanks, as before). Drops the Product/Management/Developer Tools split and its icon remapping, and restores the sidebar's original collapsed-by-default behavior now that navigation.expand isn't enabled. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
1 parent 4ba018f commit d357cf0

3 files changed

Lines changed: 87 additions & 100 deletions

File tree

mkdocs.yml

Lines changed: 86 additions & 93 deletions
Original file line numberDiff line numberDiff line change
@@ -69,29 +69,24 @@ extra:
6969
user_feedback: "true"
7070
community_url: "https://community.codacy.com/"
7171
support_email: "support@codacy.com"
72-
# Ionicons displayed for top-level tabs and, when navigation.tabs is
73-
# active, for the top section within each tab's sidebar (see level == 2
74-
# handling in theme/partials/nav-item.html).
72+
# Ionicons displayed for the top section within each tab's sidebar (see
73+
# level == 2 handling in theme/partials/nav-item.html).
7574
sidebar_icons:
76-
"Product": "business-outline"
77-
"Management": "settings-outline"
78-
"Developer Tools": "terminal-outline"
79-
"Release Notes": "megaphone-outline"
8075
"Documentation home": "home-outline"
8176
"Getting started": "rocket-outline"
82-
"Quality": "code-slash-outline"
83-
"Security": "shield-checkmark-outline"
84-
"AI": "sparkles-outline"
85-
"Coverage": "umbrella-outline"
86-
"Support": "medical-outline"
87-
"Configuring your repositories": "folder-open-outline"
77+
"Codacy Guardrails (IDE Extension)": "shield-checkmark-outline"
78+
"Codacy Cloud CLI": "terminal-outline"
79+
"Codacy AI": "sparkles-outline"
80+
"Repositories on Codacy": "folder-open-outline"
81+
"Configuring your repositories": "settings-outline"
8882
"Organizations": "people-outline"
89-
"Your account": "person-circle-outline"
9083
"Enterprise Cloud": "business-outline"
84+
"Your account": "person-circle-outline"
85+
"Codacy API": "code-slash-outline"
9186
"Managing Codacy Self-hosted": "server-outline"
92-
"Codacy Guardrails (IDE Extension)": "shield-checkmark-outline"
93-
"Codacy Cloud CLI": "code-slash-outline"
94-
"Codacy API": "share-social-outline"
87+
"Troubleshooting and FAQs": "medical-outline"
88+
"Release notes": "megaphone-outline"
89+
"Special thanks": "heart-outline"
9590
# Do not show a generated-by badge in the footer.
9691
generator: false
9792
# Add pull request preview banner
@@ -621,7 +616,7 @@ plugins:
621616
"repositories-configure/file-extensions.md": "repositories-configure/languages.md"
622617

623618
nav:
624-
- Product:
619+
- Documentation:
625620
- Documentation home: "index.md"
626621
- Getting started:
627622
- getting-started/codacy-quickstart.md
@@ -633,70 +628,26 @@ nav:
633628
- getting-started/supported-languages-and-tools.md
634629
- getting-started/which-permissions-does-codacy-need-from-my-account.md
635630
- getting-started/adding-a-codacy-badge.md
636-
- Quality:
637-
- repositories/issues.md
638-
- repositories-configure/configuring-code-patterns.md
639-
- repositories-configure/adjusting-quality-gates.md
640-
- repositories-configure/adjusting-quality-goals.md
641-
- organizations/using-coding-standards.md
642-
- organizations/using-gate-policies.md
643-
- Using your repository:
644-
- repositories/repository-dashboard.md
645-
- repositories/commits.md
646-
- repositories/files.md
647-
- repositories/pull-requests.md
648-
- Security:
649-
- organizations/managing-security-and-risk.md
650-
- Slack integration for Security issues: organizations/integrations/slack-integration.md
651-
- Jira integration for Security and risk management: organizations/integrations/jira-integration.md
652-
- AI:
631+
- Codacy Guardrails (IDE Extension):
632+
- codacy-guardrails/codacy-guardrails-getting-started.md
633+
- codacy-guardrails/codacy-guardrails-how-to-use.md
634+
- codacy-guardrails/codacy-guardrails-how-to-configure-rules.md
635+
- codacy-guardrails/codacy-guardrails-limitations.md
636+
- codacy-guardrails/codacy-guardrails-troubleshooting.md
637+
- codacy-guardrails/codacy-guardrails-faq.md
638+
- Codacy Cloud CLI:
639+
- codacy-cloud-cli/index.md
640+
- Codacy AI:
653641
- codacy-ai/codacy-ai.md
654-
- organizations/ai-risk-hub.md
655-
- Coverage:
642+
- Repositories on Codacy:
643+
- repositories/repository-dashboard.md
644+
- repositories/commits.md
645+
- repositories/files.md
646+
- repositories/issues.md
656647
- repositories/coverage.md
657-
- coverage-reporter/index.md
658-
- coverage-reporter/alternative-ways-of-running-coverage-reporter.md
659-
- coverage-reporter/uploading-coverage-in-advanced-scenarios.md
660-
- coverage-reporter/troubleshooting-coverage-cli-issues.md
661-
- Enterprise Cloud:
662-
- enterprise-cloud/github-enterprise-cloud.md
663-
- Managing Codacy Self-hosted: "!include submodules/chart/mkdocs.yml"
664-
- Support:
665-
- General:
666-
- faq/general/which-platforms-and-technologies-does-codacy-support.md
667-
- faq/general/how-does-codacy-support-github-enterprise.md
668-
- faq/general/how-does-codacy-support-gitlab-cloud.md
669-
- faq/general/how-does-codacy-support-gitlab-enterprise.md
670-
- faq/general/how-does-codacy-support-bitbucket-cloud.md
671-
- faq/general/how-does-codacy-support-bitbucket-server.md
672-
- faq/general/how-does-codacy-keep-my-data-secure.md
673-
- faq/general/how-does-codacy-protect-my-privacy.md
674-
- faq/general/does-codacy-keep-audit-logs.md
675-
- faq/general/how-do-i-allowlist-codacy-cloud-on-my-git-provider.md
676-
- faq/general/how-can-i-change-or-cancel-my-plan.md
677-
- Repositories:
678-
- faq/repositories/how-do-i-reanalyze-my-repository.md
679-
- faq/repositories/i-renamed-my-repository-on-the-git-provider.md
680-
- Code analysis:
681-
- faq/code-analysis/which-metrics-does-codacy-calculate.md
682-
- faq/code-analysis/why-does-codacy-show-unexpected-coverage-changes.md
683-
- faq/code-analysis/does-codacy-place-limits-on-the-code-analysis.md
684-
- faq/code-analysis/does-codacy-check-for-dependencies.md
685-
- faq/code-analysis/how-long-does-it-take-for-my-repository-to-be-analyzed.md
686-
- faq/code-analysis/how-to-skip-an-analysis.md
687-
- faq/code-analysis/can-i-bypass-codacy-status-check.md
688-
- faq/code-analysis/how-to-configure-php-codesniffer-coding-standards.md
689-
- Troubleshooting:
690-
- faq/troubleshooting/why-cant-i-see-my-organization.md
691-
- faq/troubleshooting/why-did-codacy-stop-commenting-on-pull-requests.md
692-
- faq/troubleshooting/why-arent-duplication-metrics-being-calculated.md
693-
- faq/troubleshooting/why-isnt-my-public-repository-being-analyzed.md
694-
- faq/troubleshooting/not-a-member-of-the-organization.md
695-
- faq/troubleshooting/we-no-longer-have-access-to-this-repository.md
696-
- faq/troubleshooting/why-is-my-file-over-150-kb-missing.md
697-
- faq/troubleshooting/error-line-endings.md
698-
- Management:
648+
- repositories/pull-requests.md
699649
- Configuring your repositories:
650+
- repositories-configure/configuring-code-patterns.md
700651
- repositories-configure/managing-branches.md
701652
- Managing integrations:
702653
- repositories-configure/integrations/github-integration.md
@@ -705,6 +656,13 @@ nav:
705656
- repositories-configure/integrations/post-commit-hooks.md
706657
- repositories-configure/ignoring-files.md
707658
- repositories-configure/languages.md
659+
- repositories-configure/adjusting-quality-gates.md
660+
- repositories-configure/adjusting-quality-goals.md
661+
- Setting up code coverage:
662+
- coverage-reporter/index.md
663+
- coverage-reporter/alternative-ways-of-running-coverage-reporter.md
664+
- coverage-reporter/uploading-coverage-in-advanced-scenarios.md
665+
- coverage-reporter/troubleshooting-coverage-cli-issues.md
708666
- Local analysis:
709667
- repositories-configure/local-analysis/client-side-tools.md
710668
- repositories-configure/local-analysis/running-aligncheck.md
@@ -720,27 +678,27 @@ nav:
720678
- organizations/managing-repositories.md
721679
- organizations/segments.md
722680
- Reporting:
723-
- organizations/reporting/organization-overview.md
724-
- organizations/reporting/issues-metrics.md
725-
- organizations/reporting/codacy-usage.md
726-
- organizations/integrations/default-git-provider-integration-settings.md
681+
- organizations/reporting/organization-overview.md
682+
- organizations/reporting/issues-metrics.md
683+
- organizations/reporting/codacy-usage.md
684+
- organizations/using-gate-policies.md
685+
- organizations/using-coding-standards.md
686+
- organizations/ai-risk-hub.md
687+
- Managing integrations:
688+
- organizations/integrations/default-git-provider-integration-settings.md
689+
- Slack integration for Security issues: organizations/integrations/slack-integration.md
690+
- Jira integration for Security and risk management: organizations/integrations/jira-integration.md
691+
- organizations/managing-security-and-risk.md
727692
- organizations/managing-people.md
728693
- organizations/audit-logs-for-organizations.md
729694
- organizations/roles-and-permissions-for-organizations.md
730695
- organizations/changing-your-plan-and-billing.md
696+
- Enterprise Cloud:
697+
- enterprise-cloud/github-enterprise-cloud.md
731698
- Your account:
732699
- account/managing-your-profile.md
733700
- account/emails.md
734701
- account/user-session-management.md
735-
- Developer Tools:
736-
- Codacy Guardrails (IDE Extension):
737-
- codacy-guardrails/codacy-guardrails-getting-started.md
738-
- codacy-guardrails/codacy-guardrails-how-to-use.md
739-
- codacy-guardrails/codacy-guardrails-how-to-configure-rules.md
740-
- codacy-guardrails/codacy-guardrails-limitations.md
741-
- codacy-guardrails/codacy-guardrails-troubleshooting.md
742-
- codacy-guardrails/codacy-guardrails-faq.md
743-
- Codacy Cloud CLI: codacy-cloud-cli/index.md
744702
- Codacy API:
745703
- codacy-api/using-the-codacy-api.md
746704
- codacy-api/api-tokens.md
@@ -755,7 +713,42 @@ nav:
755713
- codacy-api/examples/identifying-commits-without-coverage-data.md
756714
- codacy-api/examples/uploading-dast-results.md
757715
- codacy-api/examples/triggering-dast-scans.md
758-
- Release Notes:
716+
- Managing Codacy Self-hosted: "!include submodules/chart/mkdocs.yml"
717+
- Troubleshooting and FAQs:
718+
- General:
719+
- faq/general/which-platforms-and-technologies-does-codacy-support.md
720+
- faq/general/how-does-codacy-support-github-enterprise.md
721+
- faq/general/how-does-codacy-support-gitlab-cloud.md
722+
- faq/general/how-does-codacy-support-gitlab-enterprise.md
723+
- faq/general/how-does-codacy-support-bitbucket-cloud.md
724+
- faq/general/how-does-codacy-support-bitbucket-server.md
725+
- faq/general/how-does-codacy-keep-my-data-secure.md
726+
- faq/general/how-does-codacy-protect-my-privacy.md
727+
- faq/general/does-codacy-keep-audit-logs.md
728+
- faq/general/how-do-i-allowlist-codacy-cloud-on-my-git-provider.md
729+
- faq/general/how-can-i-change-or-cancel-my-plan.md
730+
- Repositories:
731+
- faq/repositories/how-do-i-reanalyze-my-repository.md
732+
- faq/repositories/i-renamed-my-repository-on-the-git-provider.md
733+
- Code analysis:
734+
- faq/code-analysis/which-metrics-does-codacy-calculate.md
735+
- faq/code-analysis/why-does-codacy-show-unexpected-coverage-changes.md
736+
- faq/code-analysis/does-codacy-place-limits-on-the-code-analysis.md
737+
- faq/code-analysis/does-codacy-check-for-dependencies.md
738+
- faq/code-analysis/how-long-does-it-take-for-my-repository-to-be-analyzed.md
739+
- faq/code-analysis/how-to-skip-an-analysis.md
740+
- faq/code-analysis/can-i-bypass-codacy-status-check.md
741+
- faq/code-analysis/how-to-configure-php-codesniffer-coding-standards.md
742+
- Troubleshooting:
743+
- faq/troubleshooting/why-cant-i-see-my-organization.md
744+
- faq/troubleshooting/why-did-codacy-stop-commenting-on-pull-requests.md
745+
- faq/troubleshooting/why-arent-duplication-metrics-being-calculated.md
746+
- faq/troubleshooting/why-isnt-my-public-repository-being-analyzed.md
747+
- faq/troubleshooting/not-a-member-of-the-organization.md
748+
- faq/troubleshooting/we-no-longer-have-access-to-this-repository.md
749+
- faq/troubleshooting/why-is-my-file-over-150-kb-missing.md
750+
- faq/troubleshooting/error-line-endings.md
751+
- Release notes:
759752
- release-notes/index.md
760753
- Cloud:
761754
- 2026:

theme/assets/vendor/ionicons/svg/umbrella-outline.svg

Lines changed: 0 additions & 1 deletion
This file was deleted.

theme/partials/nav-item.html

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -63,12 +63,7 @@
6363
<li class="{{ class }} md-nav__item--nested">
6464
{% if not is_pruned %}
6565
{% set checked = "checked" if nav_item.active %}
66-
{# Every level looks expanded by default on desktop. `md-toggle--indeterminate`
67-
drives Material's desktop-only grid-collapse CSS (@media min-width: 76.25em)
68-
without touching `checked` itself or requiring JS: it has zero effect within
69-
the mobile media query, so the lifted drawer's one-branch-at-a-time behavior
70-
there is untouched, and there's no post-load re-render to flash on page load. #}
71-
{% if not checked %}{% set indeterminate = "md-toggle--indeterminate" %}{% endif %}
66+
{% if "navigation.expand" in features and not checked %}{% set indeterminate = "md-toggle--indeterminate" %}{% endif %}
7267
<input class="md-nav__toggle md-toggle {{ indeterminate }}" type="checkbox" id="{{ path }}" {{ checked }}>
7368
{% if not index %}
7469
{% set tabindex = "0" if not is_section %}

0 commit comments

Comments
 (0)