Skip to content

docs: Restructure documentation to improve organization #9578

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

Merged
merged 39 commits into from
May 20, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
39 commits
Select commit Hold shift + click to select a range
d3bcecb
Remove redirect_from entries from front matter in MDX files
igorlukanin May 16, 2025
d546c5c
docs: Restructure configuration reference section
igorlukanin May 16, 2025
0fa373d
docs: Move environment variables page to product/configuration/reference
igorlukanin May 16, 2025
cc4b6b5
docs: Move data model reference pages to product/data-modeling/reference
igorlukanin May 16, 2025
28ea2e6
docs: Move cube_dbt page to product/data-modeling/reference
igorlukanin May 16, 2025
145ff92
docs: Move lkml2cube page to product/data-modeling/reference
igorlukanin May 16, 2025
c12873c
docs: Move Python cube package to data modeling reference section
igorlukanin May 16, 2025
1408b9e
docs: Move error reference sections to respective pages
igorlukanin May 16, 2025
c945d4e
docs: Remove reference section from navigation
igorlukanin May 16, 2025
9b777e6
docs: Move active users recipe to data modeling section
igorlukanin May 16, 2025
2148075
docs: Move event analytics recipe to data modeling section
igorlukanin May 16, 2025
3ffc682
docs: Move cohort retention recipe to data modeling section
igorlukanin May 16, 2025
9ef80f9
docs: Move funnel analysis recipe to data modeling section
igorlukanin May 16, 2025
cb04bc0
docs: Move XIRR recipe to data modeling section
igorlukanin May 16, 2025
770e73d
docs: Move mandatory filters recipe to auth section
igorlukanin May 19, 2025
90e6e9e
docs: Move column-based access recipe to auth section
igorlukanin May 19, 2025
1e492e2
docs: Move role-based access recipe to auth section
igorlukanin May 19, 2025
7c2ceec
docs: Move controlling-access-to-cubes-and-views recipe to auth section
igorlukanin May 19, 2025
1caa512
docs: Move multitenancy recipe to configuration section
igorlukanin May 19, 2025
792fda9
docs: Move SQL API LDAP recipe to auth section
igorlukanin May 19, 2025
52c6d90
docs: Move Auth0 and AWS Cognito guides to auth section
igorlukanin May 19, 2025
1c723e7
docs: Move data modeling recipes to proper section
igorlukanin May 19, 2025
eb15397
docs: Move code reusability recipes to data modeling section
igorlukanin May 19, 2025
5c9b174
docs: Move multitenancy recipe to configuration recipes section
igorlukanin May 19, 2025
65371cc
docs: move environment variables recipe to configuration section
igorlukanin May 19, 2025
73c2d54
docs: move data sources recipes to configuration section
igorlukanin May 19, 2025
8d9db00
docs: move queries recipes to APIs & Integrations section
igorlukanin May 19, 2025
27ae16a
docs: Move query acceleration recipes to caching section
igorlukanin May 19, 2025
3bb27f8
docs: Move Query History export recipe to workspace section
igorlukanin May 19, 2025
7ff954e
docs: Move data exploration recipes to APIs & Integrations section
igorlukanin May 19, 2025
f5d176b
docs: Remove migrating-from-express-to-docker page
igorlukanin May 19, 2025
0c292c1
docs: Move dbt guide to data modeling recipes section
igorlukanin May 19, 2025
0ae3957
docs: Move designing-metrics guide to data modeling recipes section
igorlukanin May 19, 2025
d9fba34
docs: Move style guide to data modeling recipes section
igorlukanin May 19, 2025
9874e59
docs: Move data store cost saving guide to configuration recipes section
igorlukanin May 19, 2025
f3a5118
docs: Remove guides section
igorlukanin May 19, 2025
6d62ec3
docs: Remove FAQs section and update distribution page
igorlukanin May 19, 2025
f81b1ae
docs: Merge tenant data model recipes into single page
igorlukanin May 19, 2025
8b1ab74
Fixes
igorlukanin May 20, 2025
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
27 changes: 27 additions & 0 deletions docs/.claude/commands/move-page.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Move documentation page

I need to move a documentation page from its current location to a new one within our documentation site. Please help me with the full process including:

1. Moving the source file to the destination directory:
- If there's a file with the same name in the destination directory, ask for the new name and rename the source file before moving it
- Use the `mv` command to move the file to the new location

2. Updating relevant _meta.js files to maintain proper navigation:
- Add the page to the destination directory's _meta.js file
- Remove the page from the source directory's _meta.js file
- If the source _meta.js file becomes empty (just contains `module.exports = {}`)
- Delete it
- Delete the directory where that _meta.js file was from the _meta.js file in its parent directory

3. Finding and updating all internal references/links to the moved page:
- Search for references to the old URL path in all files
- Pay special attention to link references at the bottom of files
- Check plugins that might construct URLs programmatically

4. Adding a redirect from the old URL to the new one:
- Add a new entry at the top of the redirects.json file
- Format should follow existing entries with "permanent": true

Before starting, ask for:
- Source page path (in URL format, e.g., /reference/configuration/environment-variables)
- Destination page path (in URL format, e.g., /product/configuration/reference/environment-variables)
81 changes: 81 additions & 0 deletions docs/CLAUDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
# CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

## Repository Overview

This repository contains the documentation site for Cube, a semantic layer for building data applications. The documentation is built using Next.js with the Nextra documentation theme and MDX for content authoring.

## Project Structure

- `/pages`: Contains all the documentation content in MDX format
- `/components`: React components used throughout the documentation site
- `/common`: General UI components like buttons, logos, etc.
- `/layouts`: Page layout components
- `/mdx`: Custom components for use within MDX content
- `/overrides`: Components that override Nextra defaults
- `/public`: Static assets (images, icons)
- `/styles`: Global CSS styles
- `/scripts`: Utility scripts for managing content

## Development Commands

```bash
# Start development server
npm run dev

# Build for production
npm run build

# Start production server
npm run start

# Utility commands for content management
npm run create-redirects # Create redirect entries
npm run migrate-content # Run content migration scripts
npm run update-links # Update links in content files
```

## Technology Stack

- **Framework**: Next.js with Nextra theme for documentation
- **Content**: MDX (Markdown with JSX)
- **Styling**: CSS/SCSS modules with Tailwind CSS
- **Deployment**: Vercel

## Content Organization

The documentation follows a hierarchical structure:

1. Main sections are defined in `/pages/_meta.js`
2. Each section has its own `_meta.js` file that defines the order and titles of pages
3. Content is written in MDX files with frontmatter

## Component Usage in MDX

The documentation uses custom MDX components for specialized content presentation:

- `<AlertBox>` - For highlighting important information
- `<CodeTabs>` - For code examples in multiple languages
- `<Grid>` and `<GridItem>` - For creating responsive grids
- `<YouTubeVideo>` - For embedding videos
- `<Screenshot>` - For displaying screenshots

## Best Practices

1. **MDX Content**:
- Use the appropriate custom components for different content types
- Follow the existing section structure when adding new pages
- Include proper frontmatter with title and description

2. **Component Development**:
- Use CSS/SCSS modules for component styling
- Follow the existing folder structure for new components
- Export components through index files for cleaner imports

3. **Navigation**:
- Update `_meta.js` files when adding new pages to ensure proper navigation

## Deployment

The site is deployed to Vercel. The deployment process is automated via GitHub integration.
10 changes: 0 additions & 10 deletions docs/pages/_meta.js
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,4 @@ module.exports = {
type: "page",
title: "Documentation",
},

reference: {
type: "page",
title: "Reference",
},

guides: {
type: "page",
title: "Guides",
},
};
7 changes: 0 additions & 7 deletions docs/pages/guides/_meta.js

This file was deleted.

86 changes: 0 additions & 86 deletions docs/pages/guides/recipes.mdx

This file was deleted.

13 changes: 0 additions & 13 deletions docs/pages/guides/recipes/_meta.js

This file was deleted.

7 changes: 0 additions & 7 deletions docs/pages/guides/recipes/access-control/_meta.js

This file was deleted.

Loading