Files
actual/docs-sidebar.js
Jonathan Fang af19c9d239 Reorganizing documentation since SimpleFIN will be officially released #2 (#459)
- removed simplefin from experimental tab
- added mention of simplefin in bank-sync
- split bank-sync into gocardless and simplefin
- created dropdown for bank-sync
- proofreaded punctuation & image alignment in gocardless and simplefin
guides

Fixes https://github.com/actualbudget/docs/issues/452,
https://github.com/actualbudget/docs/pull/453 and fixes
https://github.com/actualbudget/docs/issues/454

I'm not sure why https://github.com/actualbudget/docs/issues/458 got
closed, so I'm making a new one here.

---------

Co-authored-by: youngcw <calebyoung94@gmail.com>
Co-authored-by: Matt Fiddaman <github@m.fiddaman.uk>
2024-10-03 18:12:23 +01:00

348 lines
8.3 KiB
JavaScript

/**
* Creating a sidebar enables you to:
- create an ordered group of docs
- render a sidebar for each doc of that group
- provide next/previous navigation
The sidebars can be generated from the filesystem, or explicitly defined here.
Create as many sidebars as you want.
*/
// @ts-check
/**
* @param {string} title
* @returns {import('@docusaurus/plugin-content-docs/src/sidebars/types').SidebarItemHtml}
*/
const unavailable = title => ({
type: 'html',
value: title,
className: 'menu__link menu__link--unavailable',
defaultStyle: true,
});
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebars = {
docs: [
'index',
'vision',
'releases',
{
type: 'category',
label: 'A Tour of Actual',
link: {
type: 'doc',
id: 'tour/index',
},
items: [
'tour/user-interface',
'tour/budget',
'tour/accounts',
'tour/reports',
'tour/schedules',
'tour/payees',
'tour/rules',
],
},
{
type: 'category',
label: 'Getting Started',
collapsible: false,
items: [
'getting-started/roadmap-for-new-users',
'getting-started/envelope-budgeting',
{
type: 'category',
label: 'Installation and Configuration',
link: {
type: 'doc',
id: 'install/index',
},
items: [
{
type: 'category',
label: 'On Your Own Machine',
collapsible: false,
items: ['install/local', 'install/docker'],
},
{
type: 'category',
label: 'In the Cloud',
collapsible: false,
items: ['install/pikapods', 'install/fly'],
},
{
type: 'category',
label: 'Configuration',
collapsible: false,
items: [ 'config/index', 'config/https', 'advanced/http-header-auth', 'config/reverse-proxies' ],
},
],
},
{
type: 'category',
label: 'Migration',
link: {
type: 'doc',
id: 'migration/index',
},
items: [
'migration/actual-import',
'migration/ynab4',
'migration/nynab',
],
},
],
},
{
type: 'category',
label: 'Using Actual',
collapsible: false,
items: [
'getting-started/starting-fresh',
{
type: 'category',
label: 'Budgeting',
collapsed: true,
link: {
type: 'doc',
id: 'budgeting/index',
},
items: [
'budgeting/categories',
{
type: 'category',
label: 'How to articles about budgeting',
collapsible: false,
link: {
type: 'doc',
id: 'budgeting/index',
},
items: [
'budgeting/returns-and-reimbursements',
{
type: 'category',
label: 'Managing Credit Cards',
collapsible: true,
link: {
type: 'doc',
id: 'budgeting/credit-cards/index',
},
items: ['budgeting/credit-cards/carrying-debt'],
},
'budgeting/joint-accounts',
'advanced/restart',
]
},
],
},
// End of Budgeting
'schedules',
{
type: 'category',
label: 'Accounts & Transactions',
collapsed: true,
link: {
type: 'doc',
id: 'accounts/index',
},
items: [
'transactions/filters',
'transactions/transfers',
{
type: 'category',
label: 'Rules',
collapsed: true,
link: {
type: 'doc',
id: 'budgeting/rules/index',
},
items: ['budgeting/rules/custom'],
},
'transactions/importing',
'accounts/reconciliation',
'transactions/payees',
'transactions/bulk-editing',
{
type: 'category',
label: 'Connecting Your Bank',
link: {
type: 'doc',
id: 'advanced/bank-sync',
},
items: [
'advanced/bank-sync/gocardless',
'advanced/bank-sync/simplefin',
],
},
'advanced/scripts/modify-transfers',
],
},
{
type: 'category',
label: 'Reports',
collapsed: true,
link: {
type: 'doc',
id: 'reports/index',
},
items: [
'reports/custom-reports'
],
},
{
type: 'category',
label: 'Backup & Restore',
collapsed: true,
items: ['backup-restore/backup', 'backup-restore/restore'],
},
'settings/index',
'getting-started/sync',
'getting-started/manage-files',
{
type: 'category',
label: 'Experimental features',
collapsed: true,
items: [
'experimental/goal-templates',
'experimental/monthly-cleanup',
'experimental/tracking-budget',
],
},
'getting-started/tips-tricks',
{
type: 'category',
label: 'API',
link: { type: 'doc', id: 'api/index' },
items: [
'api/reference',
{
type: 'category',
label: 'ActualQL',
collapsed: true,
link: {
type: 'doc',
id: 'api/actual-ql/index',
},
items: ['api/actual-ql/functions', 'api/actual-ql/examples'],
},
],
},
],
},
{
type: 'category',
label: 'Help & Support',
collapsible: false,
items: [
'faq',
{
type: 'category',
label: 'Troubleshooting',
collapsed: true,
items: [
'troubleshooting/server',
'troubleshooting/shared-array-buffer',
'troubleshooting/reset_password',
'troubleshooting/edge-browser',
],
},
'community-repos',
],
},
{
type: 'category',
label: 'Contributing',
link: {
type: 'doc',
id: 'contributing/index',
},
collapsed: true,
items: [
{
type: 'link',
label: 'Open Bug Reports',
href: 'https://github.com/actualbudget/actual/issues',
},
{
type: 'link',
label: 'Feature Requests',
href: 'https://github.com/actualbudget/actual/issues?q=label%3A%22needs+votes%22+sort%3Areactions-%2B1-desc+',
},
{
type: 'category',
label: 'The Actual Project Structure',
link: {
type: 'doc',
id: 'contributing/project-details/index',
},
items: [
'contributing/project-details/database',
'contributing/project-details/architecture',
'contributing/project-details/feature-flags',
'contributing/project-details/electron',
'contributing/project-details/migrations',
'contributing/project-details/advice',
],
},
'contributing/i18n',
'contributing/preview-builds',
'contributing/releasing',
'contributing/windows',
{
type: 'category',
label: 'Documentation',
collapsible: false,
items: [
'contributing/writing-docs',
],
},
{
type: 'category',
label: 'Project Leadership',
collapsible: false,
items: [
'contributing/leadership/funding',
'contributing/leadership/new-core-contributors-guide',
],
},
],
},
],
};
module.exports = sidebars;