Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
43 changes: 6 additions & 37 deletions docs/.vitepress/config.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
import { version } from '../../package.json'
import { defineConfig } from 'vitepress'

// https://vitepress.dev/reference/site-config
Expand All @@ -17,7 +16,7 @@ export default defineConfig({
themeConfig: {
// https://vitepress.dev/reference/default-theme-config
nav: [
{ text: 'Guide', link: '/0-installation' },
{ text: 'Guide', link: '/v3/0-installation' },
{ text: 'Discuss', link: 'https://github.com/activeadmin/activeadmin/discussions' },
{
text: 'Demo',
Expand All @@ -27,8 +26,12 @@ export default defineConfig({
]
},
{
text: version.replace("-", "."), // use Ruby format for version text
text: 'v3.x', // use Ruby format for version text
items: [
{
text: 'v3.x',
link: '/v3/0-installation'
},
{
text: 'Changelog',
link: 'https://github.com/activeadmin/activeadmin/releases',
Expand All @@ -40,40 +43,6 @@ export default defineConfig({
],
}
],
sidebar: [
{
text: 'Setup',
items: [
{ text: 'Installation', link: '/0-installation' },
{ text: 'Configuration', link: '/1-general-configuration' }
]
},
{
text: 'Resources',
items: [
{ text: 'Working with Resources', link: '/2-resource-customization' },
{ text: 'Customize the Index page', link: '/3-index-pages' },
{ text: 'Index as a Table', link: '/3-index-pages/index-as-table' },
{ text: 'Custom Index View', link: '/3-index-pages/custom-index' },
{ text: 'CSV Format', link: '/4-csv-format' },
{ text: 'Forms', link: '/5-forms' },
{ text: 'Customize the Show Page', link: '/6-show-pages' },
{ text: 'Sidebar Sections', link: '/7-sidebars' },
{ text: 'Custom Controller Actions', link: '/8-custom-actions' },
{ text: 'Batch Actions', link: '/9-batch-actions' },
{ text: 'Decorators', link: '/11-decorators' },
{ text: 'Authorization Adapter', link: '/13-authorization-adapter' }
]
},
{
text: 'Other',
items: [
{ text: 'Custom Pages', link: '/10-custom-pages' },
{ text: 'Arbre Components', link: '/12-arbre-components' },
{ text: 'Gotchas', link: '/14-gotchas' },
]
}
],
socialLinks: [
{ icon: 'github', link: 'https://github.com/activeadmin/activeadmin' },
{ icon: 'slack', link: 'https://activeadmin.slack.com/' },
Expand Down
1 change: 0 additions & 1 deletion docs/CNAME

This file was deleted.

8 changes: 4 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ hero:
actions:
- theme: brand
text: Getting Started
link: /0-installation
link: /v3/0-installation
- theme: alt
text: View on GitHub
link: https://github.com/activeadmin/activeadmin
Expand All @@ -25,12 +25,12 @@ features:
- icon: 🎬
title: Action Items
details: Add buttons or links as action items in the page header for a resource.
link: /8-custom-actions
link: /v3/8-custom-actions
linkText: Learn about action items
- icon: 🔍
title: Filters
details: Allow users to filter resources by searching strings, text fields, dates, and numeric values.
link: /3-index-pages
link: /v3/3-index-pages
linkText: Learn about filters
- icon: 🗂️
title: Scopes
Expand All @@ -41,7 +41,7 @@ features:
- icon: 📋
title: Sidebar Sections
details: Add your own sections to the sidebar using a simple DSL.
link: /7-sidebars
link: /v3/7-sidebars
linkText: Learn about sidebar sections
- icon: 💾
title: Downloads
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
63 changes: 63 additions & 0 deletions docs/v3/config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
import { defineAdditionalConfig } from 'vitepress'

export default defineAdditionalConfig({
themeConfig: {
nav: [
{ text: 'Guide', link: '/v3/0-installation' },
{ text: 'Discuss', link: 'https://github.com/activeadmin/activeadmin/discussions' },
{
Comment on lines +1 to +8
Copy link

Copilot AI Mar 20, 2026

Choose a reason for hiding this comment

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

This file defines sidebar/nav config for the v3 docs, but it is not referenced from docs/.vitepress/config.js and there’s no other code in the repo that imports it. If VitePress v2 isn’t auto-loading docs/v3/config.js, these settings will be ignored and /v3/* pages will lose their sidebar navigation. Consider moving this into the main config (path-keyed sidebar) or wiring it in explicitly.

Copilot uses AI. Check for mistakes.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

it's working

image

text: 'Demo',
items: [
{ text: 'GitHub Repository', link: 'https://github.com/activeadmin/demo.activeadmin.info' },
{ text: 'Demo App', link: 'https://demo.activeadmin.info/' },
],
},
{
text: 'v3.x',
items: [
{ text: 'v3.x', link: '/v3/0-installation' },
{ text: 'Changelog', link: 'https://github.com/activeadmin/activeadmin/releases' },
{ text: 'Contributing', link: 'https://github.com/activeadmin/activeadmin/blob/master/CONTRIBUTING.md' },
],
},
],
sidebar: [
{
text: 'Setup',
items: [
{ text: 'Installation', link: '/v3/0-installation' },
{ text: 'Configuration', link: '/v3/1-general-configuration' },
],
},
{
text: 'Resources',
items: [
{ text: 'Working with Resources', link: '/v3/2-resource-customization' },
{ text: 'Customize the Index page', link: '/v3/3-index-pages' },
{ text: 'Index as a Table', link: '/v3/3-index-pages/index-as-table' },
{ text: 'Custom Index View', link: '/v3/3-index-pages/custom-index' },
{ text: 'CSV Format', link: '/v3/4-csv-format' },
{ text: 'Forms', link: '/v3/5-forms' },
{ text: 'Customize the Show Page', link: '/v3/6-show-pages' },
{ text: 'Sidebar Sections', link: '/v3/7-sidebars' },
{ text: 'Custom Controller Actions', link: '/v3/8-custom-actions' },
{ text: 'Batch Actions', link: '/v3/9-batch-actions' },
{ text: 'Decorators', link: '/v3/11-decorators' },
{ text: 'Authorization Adapter', link: '/v3/13-authorization-adapter' },
],
},
{
text: 'Other',
items: [
{ text: 'Custom Pages', link: '/v3/10-custom-pages' },
{ text: 'Arbre Components', link: '/v3/12-arbre-components' },
{ text: 'Gotchas', link: '/v3/14-gotchas' },
],
},
],
editLink: {
pattern: 'https://github.com/activeadmin/activeadmin/edit/master/docs/:path',
text: 'Edit this page on GitHub',
},
},
})
File renamed without changes.
49 changes: 49 additions & 0 deletions docs/v3/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
# https://vitepress.dev/reference/default-theme-home-page
layout: home

hero:
name: ActiveAdmin
text: An admin engine for Rails applications
tagline: Abstracts common patterns to implement beautiful and elegant interfaces with ease.

actions:
- theme: brand
text: Getting Started
link: /v3/0-installation
- theme: alt
text: View on GitHub
link: https://github.com/activeadmin/activeadmin

features:
- icon: 🌎
title: Global Navigation
details: Customizable navigation allows you to create usable admin interfaces for your business.
- icon: 🔒
title: User Authentication
details: Use the bundled Devise configuration or implement your own authorization using the provided hooks.
- icon: 🎬
title: Action Items
details: Add buttons or links as action items in the page header for a resource.
link: /v3/8-custom-actions
linkText: Learn about action items
- icon: 🔍
title: Filters
details: Allow users to filter resources by searching strings, text fields, dates, and numeric values.
link: /v3/3-index-pages
linkText: Learn about filters
- icon: 🗂️
title: Scopes
details: Use scopes to create sections of mutually exclusive resources for quick navigation and reporting.
- icon: 📑
title: Custom Index Views
details: The default index screen is a table view, but custom index views are supported.
- icon: 📋
title: Sidebar Sections
details: Add your own sections to the sidebar using a simple DSL.
link: /v3/7-sidebars
linkText: Learn about sidebar sections
- icon: 💾
title: Downloads
details: Each resource becomes available as CSV, JSON, and XML with customizable output.
---
1 change: 1 addition & 0 deletions eslint.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ export default [
ignores: [
"app/assets/**",
"coverage/**",
"docs/.vitepress/cache/**",
"docs/.vitepress/dist/**",
"lib/generators/**",
"src/**",
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
"gherkin-lint": "^4.2.4",
"rollup": "^4.60.0",
"tailwindcss": "^4.2.2",
"vitepress": "^1.6.4"
"vitepress": "^2.0.0-alpha.17"
},
"scripts": {
"gherkin-lint": "gherkin-lint",
Expand Down
Loading