Skip to content

feat: Add CLI, SDK, and API documentation page to Feast UI #5337

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.

Sign up for GitHub

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
franciscojavierarceo merged 9 commits into from
May 7, 2025
Merged

feat: Add CLI, SDK, and API documentation page to Feast UI #5337

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
5523e72
Add documentation page to Feast UI with SDK, API, and CLI documentation
devin-ai-integration[bot] May 7, 2025
bed8231
Add symlink to docs directory for documentation page
devin-ai-integration[bot] May 7, 2025
dbbb3de
Update DocumentationService with hardcoded documentation content for …
devin-ai-integration[bot] May 7, 2025
8f82682
Replace docs symlink with actual reference content
devin-ai-integration[bot] May 7, 2025
6e76bef
Update Documentation icon to blue, move to last position, and add hor…
devin-ai-integration[bot] May 7, 2025
bf9a0b9
Update documentation page with improved formatting and routing
devin-ai-integration[bot] May 7, 2025
210eb53
Fix tab switching in documentation page
devin-ai-integration[bot] May 7, 2025
eaa3fc6
Simplify Rollup configuration to fix build issues
devin-ai-integration[bot] May 7, 2025
7559d53
Format rollup.config.js with trailing commas
devin-ai-integration[bot] May 7, 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
Prev Previous commit
Next Next commit
Update Documentation icon to blue, move to last position, and add hor… 
…izontal lines between CLI sections

Co-Authored-By: Francisco Javier Arceo <arceofrancisco@gmail.com>
  • Loading branch information
@devin-ai-integration @franciscojavierarceo
devin-ai-integration[bot] and franciscojavierarceo committed May 7, 2025
commit 6e76befd8e6893d23e311aebfb6c826b61b2c2d2
18 changes: 9 additions & 9 deletions ui/src/pages/Sidebar.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,15 +131,6 @@ const SideNav = () => {
renderItem: (props) => <Link {...props} to={`${baseUrl}/data-set`} />,
isSelected: useMatchSubpath(`${baseUrl}/data-set`),
},
{
name: "Documentation",
id: htmlIdGenerator("documentation")(),
icon: <EuiIcon type="documentation" />,
renderItem: (props) => (
<Link {...props} to={`${baseUrl}/documentation`} />
),
isSelected: useMatchSubpath(`${baseUrl}/documentation`),
},
{
name: "Permissions",
id: htmlIdGenerator("permissions")(),
Expand All @@ -149,6 +140,15 @@ const SideNav = () => {
),
isSelected: useMatchSubpath(`${baseUrl}/permissions`),
},
{
name: "Documentation",
id: htmlIdGenerator("documentation")(),
icon: <EuiIcon type="documentation" color="primary" />,
renderItem: (props) => (
<Link {...props} to={`${baseUrl}/documentation`} />
),
isSelected: useMatchSubpath(`${baseUrl}/documentation`),
},
],
},
];
Expand Down
6 changes: 6 additions & 0 deletions ui/src/services/DocumentationService.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ feast apply

- \`--skip-source-validation\`: Skip validation of data sources.

---

## feast materialize

Materialize features from an offline store into an online store.
Expand All @@ -32,6 +34,8 @@ feast materialize START_TS END_TS

- \`--views\`: Feature views to materialize.

---

## feast registry-dump

Dump registry contents to local file.
Expand All @@ -42,6 +46,8 @@ Dump registry contents to local file.
feast registry-dump REGISTRY_PATH
\`\`\`

---

## feast serve

Start a feature server.
Expand Down