Skip to content
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

Update Getting-Started, Icons, Tokens and Guides for a first preview release of the documentation #532

Merged
merged 52 commits into from
Dec 2, 2024
Merged
Changes from 1 commit
Commits
Show all changes
52 commits
Select commit Hold shift + click to select a range
1423ab0
added preview notif for components / swapped hopper logo
fraincs Nov 7, 2024
56dfe18
added new hopper logo - added preview tag in all components sections …
fraincs Nov 7, 2024
ccfaffb
linting error
fraincs Nov 7, 2024
1dc80d4
Added Preview Tag to Components sections/links - [feature/ds-452] (#…
fraincs Nov 7, 2024
e5aea3b
small fixes to tag
fraincs Nov 7, 2024
50ea62f
small fixes to tag - (#527)
fraincs Nov 7, 2024
7548df5
Merge branch 'main' into alpha
fraincs Nov 8, 2024
26f951b
Merge branch 'alpha' of github.com:gsoft-inc/wl-hopper into alpha
fraincs Nov 9, 2024
ba752d4
components are now shown in preview
alexasselin008 Nov 23, 2024
0d1804d
first draft of the getting started section
alexasselin008 Nov 23, 2024
db5c0de
update content
alexasselin008 Nov 25, 2024
93e3341
fixing doc
alexasselin008 Nov 26, 2024
c7dbfac
update icon documentation
alexasselin008 Nov 26, 2024
ed4e360
added a cardLink components - links are now purple
fraincs Nov 26, 2024
79c9341
Merge branch 'feature/guides' of github.com:gsoft-inc/wl-hopper into …
fraincs Nov 26, 2024
e927dde
updated RAC to 1.5 / fix for Collapsible component / small rework of …
fraincs Nov 27, 2024
8e9af4d
removed unneccessary key
fraincs Nov 27, 2024
b0884b0
upadated cardLink css
fraincs Nov 27, 2024
da2001c
reworked default tags
fraincs Nov 27, 2024
bfbece6
added expand component to documentatino
fraincs Nov 27, 2024
2977dbf
add guides navigation
alexasselin008 Nov 27, 2024
d5a38c4
update guides
alexasselin008 Nov 27, 2024
efbfd39
Merge branch 'main' into alpha
alexasselin008 Nov 28, 2024
ce579bc
Merge branch 'alpha' into feature/guides
alexasselin008 Nov 28, 2024
c68ec99
fix 404 and move guides under getting started
alexasselin008 Nov 28, 2024
d8fbd22
update dependencies and gitignore
alexasselin008 Nov 28, 2024
72424d4
fix comments
alexasselin008 Nov 28, 2024
40a660b
fix links
alexasselin008 Nov 28, 2024
13b8a92
review fixes
alexasselin008 Nov 29, 2024
c54651d
update doc
alexasselin008 Nov 29, 2024
29f352a
reworked the icon introduciton page
fraincs Nov 29, 2024
234a090
merge
fraincs Nov 29, 2024
dfd577b
styled the 404 page
fraincs Nov 29, 2024
890862c
fix link and dev script
alexasselin008 Nov 29, 2024
6d7b681
Merge branch 'feature/guides' of https://github.com/workleap/wl-hoppe…
alexasselin008 Nov 29, 2024
c07330b
doc ui fixes
fraincs Nov 29, 2024
a0ca826
Merge branch 'feature/guides' of github.com:gsoft-inc/wl-hopper into …
fraincs Nov 29, 2024
3699d9c
extract icons in their own file + convert data to TS + add controlled…
alexasselin008 Nov 29, 2024
cee960a
Merge branch 'feature/guides' of https://github.com/workleap/wl-hoppe…
alexasselin008 Nov 29, 2024
c9a136e
change url import style
alexasselin008 Nov 29, 2024
a298bb8
update indentation in examples
alexasselin008 Nov 29, 2024
d98008d
fix build
alexasselin008 Nov 29, 2024
8679ee0
added a Figure component to the documentation
fraincs Nov 29, 2024
1b45037
Merge branch 'feature/guides' of github.com:gsoft-inc/wl-hopper into …
fraincs Nov 29, 2024
a527bb3
update doc
alexasselin008 Nov 29, 2024
d8d23a5
updated npm logo
fraincs Nov 29, 2024
bcb0767
add line highlight
alexasselin008 Nov 29, 2024
38cdaf7
Merge branch 'feature/guides' of https://github.com/workleap/wl-hoppe…
alexasselin008 Nov 29, 2024
aca3c00
remove broken file
alexasselin008 Nov 29, 2024
5a905d9
Merge branch 'main' into alpha
alexasselin008 Nov 29, 2024
88b3779
Merge branch 'alpha' into feature/guides
alexasselin008 Nov 29, 2024
27aeec2
copy fix / collapsible shadow dark mode adjustments
fraincs Nov 30, 2024
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
fix 404 and move guides under getting started
  • Loading branch information
alexasselin008 committed Nov 28, 2024
commit c68ec996b24a80cf5a1ad2966dfcb191f0a75475
6 changes: 3 additions & 3 deletions apps/docs/app/getting-started/layout.tsx
Original file line number Diff line number Diff line change
@@ -7,7 +7,7 @@ import SubHeader from "@/app/ui/layout/subHeader/SubHeader";
import Wrapper from "@/app/ui/layout/wrapper/Wrapper";
import { SidebarProvider } from "@/context/sidebar/SidebarProvider";
import { allGettingStarteds } from "contentlayer/generated";
import { useSelectedLayoutSegment } from "next/navigation";
import { notFound, useSelectedLayoutSegment } from "next/navigation";
import type { ReactNode } from "react";

export default function GettingStartedLayout({ children }: { children: ReactNode }) {
@@ -16,12 +16,12 @@ export default function GettingStartedLayout({ children }: { children: ReactNode

const pageContent = allGettingStarteds.find(page => page.slug === type && page.section === section);
if (!pageContent) {
return null;
return notFound();
}

const sectionLinks = getSectionLinks(pageContent);
const allGettingStartedsLinks = getPageLinks(allGettingStarteds, {
order: ["overview", "installation-path", "advanced-options"]
order: ["overview", "installation-path", "advanced-options", "guides"]
});

return (
4 changes: 2 additions & 2 deletions apps/docs/app/guides/layout.tsx
Original file line number Diff line number Diff line change
@@ -7,7 +7,7 @@ import SubHeader from "@/app/ui/layout/subHeader/SubHeader";
import Wrapper from "@/app/ui/layout/wrapper/Wrapper";
import { SidebarProvider } from "@/context/sidebar/SidebarProvider";
import { allGuides } from "contentlayer/generated";
import { useSelectedLayoutSegment } from "next/navigation";
import { notFound, useSelectedLayoutSegment } from "next/navigation";
import type { ReactNode } from "react";

export default function GuideLayout({ children }: { children: ReactNode }) {
@@ -21,7 +21,7 @@ export default function GuideLayout({ children }: { children: ReactNode }) {
const pageContent = allGuides.find(icon => icon.slug === type && icon.section === section);

if (!pageContent) {
return null;
return notFound();
}

const sectionLinks = getSectionLinks(pageContent);
12 changes: 6 additions & 6 deletions apps/docs/app/icons/layout.tsx
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
"use client";

import type { ReactNode } from "react";
import { allIcons } from "contentlayer/generated";
import { useSelectedLayoutSegment } from "next/navigation";
import getPageLinks from "@/app/lib/getPageLinks";
import getSectionLinks from "@/app/lib/getSectionLinks";
import Sidebar from "@/app/ui/layout/sidebar/Sidebar";
import SubHeader from "@/app/ui/layout/subHeader/SubHeader";
import Wrapper from "@/app/ui/layout/wrapper/Wrapper";
import getSectionLinks from "@/app/lib/getSectionLinks";
import { SidebarProvider } from "@/context/sidebar/SidebarProvider";
import getPageLinks from "@/app/lib/getPageLinks";
import { allIcons } from "contentlayer/generated";
import { notFound, useSelectedLayoutSegment } from "next/navigation";
import type { ReactNode } from "react";

export default function TokenLayout({ children }: { children: ReactNode }) {
const selectedLayoutSegment = useSelectedLayoutSegment();
@@ -17,7 +17,7 @@ export default function TokenLayout({ children }: { children: ReactNode }) {
const pageContent = allIcons.find(icon => icon.slug === type && icon.section === section);

if (!pageContent) {
return null;
return notFound;
}

const sectionLinks = getSectionLinks(pageContent);
12 changes: 6 additions & 6 deletions apps/docs/app/tokens/layout.tsx
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
"use client";

import type { ReactNode } from "react";
import { allTokens } from "contentlayer/generated";
import { useSelectedLayoutSegment } from "next/navigation";
import getPageLinks from "@/app/lib/getPageLinks";
import getSectionLinks from "@/app/lib/getSectionLinks";
import Sidebar from "@/app/ui/layout/sidebar/Sidebar";
import SubHeader from "@/app/ui/layout/subHeader/SubHeader";
import Wrapper from "@/app/ui/layout/wrapper/Wrapper";
import { SidebarProvider } from "@/context/sidebar/SidebarProvider";
import getSectionLinks from "@/app/lib/getSectionLinks";
import getPageLinks from "@/app/lib/getPageLinks";
import { allTokens } from "contentlayer/generated";
import { notFound, useSelectedLayoutSegment } from "next/navigation";
import type { ReactNode } from "react";

export default function TokenLayout({ children }: { children: ReactNode }) {
const selectedLayoutSegment = useSelectedLayoutSegment();
@@ -17,7 +17,7 @@ export default function TokenLayout({ children }: { children: ReactNode }) {
const pageContent = allTokens.find(token => token.slug === type && token.section === section);

if (!pageContent) {
return null;
return notFound;
}

const sectionLinks = getSectionLinks(pageContent);
5 changes: 0 additions & 5 deletions apps/docs/configs/navigation.ts
Original file line number Diff line number Diff line change
@@ -20,11 +20,6 @@ export const navigation: NavItem[] = [
"path": "/icons/overview/introduction",
"status": "ready"
},
{
"label": "Guides",
"path": "/guides/overview/introduction",
"status": "ready"
},
{
"label": "Components",
"path": "/components/component-list",
Original file line number Diff line number Diff line change
@@ -102,7 +102,7 @@ Add event handlers for more control, ensuring events continue propagating as exp
```

#### Controlled Properties
You can control the component's behavior by passing a controlled property.
You can control the component's behavior by passing a controlled property.

```tsx
<PopoverTrigger {...rest} open={isHovered}>
7 changes: 7 additions & 0 deletions apps/docs/content/getting-started/overview/installation.mdx
Original file line number Diff line number Diff line change
@@ -30,3 +30,10 @@ Looking for a more tailored or specialized setup? Hopper offers advanced options
{/* TODO */}
- [Micro Frontend Architecture](#): Integrate Hopper into modular, micro-frontend-based projects. <Tag>Coming Soon</Tag>
- [Granular CSS Imports](#): Optimize performance by importing only the CSS needed for specific components. <Tag>Coming Soon</Tag>

## Guides

Explore our collection of guides designed to help you get the most out of Hopper. From styling tips to advanced customization techniques, these resources are here to support your journey with our design system. Check back often as we continue to expand with more tutorials and best practices.

- **Text Crop**: Discover how to achieve perfect vertical text alignment with our Text Crop guide. Learn how to compensate for uneven whitespace in web fonts and improve the appearance of your text using simple, effective CSS techniques. [Learn more about Text Crop](./guides/text-crop)
- **Customizing Components**: Explore the flexibility of Hopper and Orbiter with our Customizing Components guide. This article introduces various customization options, from minimal styling adjustments to building entirely new components, categorized into distinct tiers to help you make the best choice for your needs. [Learn more about Customizing Components](./guides/components)
17 changes: 0 additions & 17 deletions apps/docs/content/guides/overview/introduction.mdx

This file was deleted.