Skip to content

Commit 7ea6a91

Browse files
feat(docs): add versioned documentation (1.1.0) for design-system-docs (#4343)
* chore(docs): add versioned documentation (1.1.0) for design-system-docs ## Summary Introduces documentation versioning to the EDS documentation site, establishing 1.1.0 as the stable release and setting up 2.0.0-wip as the current development version. ## Changes ### Documentation Versioning - Created version 1.1.0 snapshot using `docusaurus docs:version 1.1.0` - Added `versioned_docs/version-1.1.0/` containing the stable documentation - Added `versioned_sidebars/version-1.1.0-sidebars.json` for version-specific navigation - Updated `versions.json` to include version 1.1.0 - Configured current docs as 2.0.0-wip (work in progress) in `docusaurus.config.ts` ### Version Dropdown - Users can now switch between versions via the navbar dropdown - Default path (`/docs/`) serves version 1.1.0 (stable) - Next version accessible at `/docs/Next/` (2.0.0-wip) ### Documentation - Added `documentation/how-to/DOCS_VERSIONING_GUIDE.md` with instructions for future version management ## Testing - [x] `pnpm docu:build` completes successfully - [x] Version dropdown appears in navbar - [x] Switching between versions works correctly ## Related - Docusaurus versioning: https://docusaurus.io/docs/versioning * Update apps/design-system-docs/versioned_docs/version-1.1.0/resources/resources.md Co-authored-by: Frida Erdal <31915755+pomfrida@users.noreply.github.com> * Update apps/design-system-docs/versioned_docs/version-1.1.0/resources/resources.md Co-authored-by: Frida Erdal <31915755+pomfrida@users.noreply.github.com> --------- Co-authored-by: Frida Erdal <31915755+pomfrida@users.noreply.github.com>
1 parent cff5521 commit 7ea6a91

104 files changed

Lines changed: 4436 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

apps/design-system-docs/docusaurus.config.ts

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,12 @@ const config: Config = {
4242
breadcrumbs: true,
4343
editUrl:
4444
'https://github.com/equinor/design-system/tree/main/apps/design-system-docs/shared',
45+
versions: {
46+
current: {
47+
label: '2.0.0-wip', // Current version label
48+
path: 'Next', // URL path for the current version
49+
},
50+
},
4551
},
4652
theme: {
4753
customCss: [
@@ -127,6 +133,11 @@ const config: Config = {
127133
type: 'search',
128134
position: 'right',
129135
},
136+
{
137+
type: 'docsVersionDropdown',
138+
position: 'left',
139+
dropdownActiveClassDisabled: true,
140+
},
130141
],
131142
},
132143
footer: {
Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# About EDS
2+
3+
Welcome to **Equinor Design System**! We've built this design system to help you create consistent, accessible digital experiences at Equinor. Whether you're designing in Figma, developing with React, or managing projects, EDS provides the tools and guidance you need to succeed.
4+
5+
We believe great design should be accessible to everyone, regardless of your technical background. Our system eliminates the need to recreate basic interface elements, so you can focus your expertise on solving real user problems and delivering exceptional experiences.
6+
7+
## Design Principles
8+
9+
These principles guide every decision we make in developing and maintaining EDS:
10+
11+
**Flexible and adaptable**
12+
Our components work together seamlessly whilst accommodating diverse use cases and requirements across different projects.
13+
14+
**Accessible by design**
15+
We prioritise inclusive design from the start, ensuring every element works for users of all abilities and supports assistive technologies.
16+
17+
**Purposeful interaction**
18+
Motion and interactive elements serve clear functions, helping users understand and navigate interfaces without unnecessary decoration.
19+
20+
**Cross-platform consistency**
21+
Whether you're building for web, mobile, or desktop applications, EDS maintains the same visual language and interaction patterns.
22+
23+
## Why EDS
24+
25+
EDS was created to support teams across Equinor in building better digital experiences more efficiently. We recognised opportunities to help teams work together more effectively whilst maintaining the high standards our users deserve.
26+
27+
**Shared foundation for efficiency** — EDS provides tested, reusable components that teams can build upon, eliminating the need to recreate similar solutions across different projects and allowing everyone to focus their expertise on solving unique user problems.
28+
29+
**Centralised maintenance** — With components maintained centrally in one place, developers no longer need to spend time maintaining multiple versions of the same interface elements. This approach ensures consistent updates and bug fixes whilst freeing up valuable development time for teams to focus on innovative features and solving complex business challenges.
30+
31+
**Unified brand experience** — We ensure that users have a consistent, professional experience as they navigate between different Equinor applications, strengthening trust and familiarity with our digital services.
32+
33+
**Built-in accessibility** — Every component includes accessibility best practices from the start, helping teams create inclusive experiences that serve all users effectively and meet compliance standards.
34+
35+
**Streamlined collaboration** — EDS provides shared tools and common terminology that enable designers and developers to work together seamlessly, reducing development time and improving communication.
36+
37+
**Quality assurance** — Our centralised approach ensures that interface solutions are thoroughly tested and maintained, giving teams confidence in their implementations and reducing long-term maintenance overhead.
38+
39+
EDS serves as the foundation that empowers teams to create exceptional user experiences whilst working more efficiently and maintaining consistency across all of Equinor's digital touchpoints.
40+
41+
## What You Get
42+
43+
EDS provides everything you need to build consistent, accessible interfaces:
44+
45+
- **React components** — Production-ready with full TypeScript support
46+
47+
- **Design tokens** — Colours, typography, spacing, and motion guidelines
48+
49+
- **Figma libraries** — Complete foundations, components, and patterns
50+
51+
- **Icons and assets** — Comprehensive visual library
52+
53+
- **Accessibility guidance** — Built-in best practices and compliance standards
54+
55+
- **Implementation support** — Clear examples and practical guidance
56+
57+
Start building immediately with tools designed for your workflow.
58+
59+
## Support & Community
60+
61+
Visit our [Support page](../support/support.md) for help channels, office hours, and direct access to our team.
62+
63+
Your feedback helps us improve EDS for everyone — we'd love to hear from you!
Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# Figma
2+
3+
Figma is the design and prototyping tool we use with EDS. This guide helps you get set up, understand permissions, and work effectively with EDS components.
4+
5+
## Getting Access
6+
7+
**Apply for access** through internal Equinor resources or contact your team administrator for help with account setup.
8+
9+
**Join your team** by contacting your team admin or owner. You can also search in Figma for your team and request access.
10+
11+
## Understanding Permissions
12+
13+
**Viewers** can:
14+
15+
- View and comment on files and projects
16+
- See all teams in the Equinor Figma organisation
17+
- Access EDS components, styles, and fonts
18+
19+
**Editors** can do everything viewers can, plus create and edit files. If you need editor access, ask your team admin to upgrade your permissions.
20+
21+
## Creating Teams
22+
23+
If you need to create a new team, read Figma's team creation guidelines first. Create teams under the Equinor organisation and make sure the team doesn't already exist. We recommend using one team per project and choosing clear, professional names.
24+
25+
**Team owner responsibilities:**
26+
27+
- Serve as the main contact for Figma administrators and the EDS core team
28+
- Follow Figma guidelines from the EDS storefront
29+
- Manage team member permissions properly
30+
- Remove inactive members to control costs
31+
32+
## Working with EDS Components
33+
34+
**Set up your workspace:**
35+
36+
- Change your nudge amount to 8px for better alignment with EDS grid system
37+
- Read EDS grid guidelines before working with EDS components
38+
- Always place content on frames or artboards
39+
40+
**Use components properly:**
41+
42+
- Find components in the Assets tab on the left sidebar
43+
- Search or scroll to locate the component you need
44+
- Drag components to your frame without changing colours or layouts
45+
- Review component updates when they become available — you can accept or deny them
46+
- When you accept updates, all instances update while preserving your custom content like text or overridden colours
47+
48+
## File Organisation
49+
50+
**Create cover pages** for each file with project information and status badges. Each file must contain a cover page on the first page named "Cover". Place the `Default File Cover` component and fill in all information so team members know who owns the file and who to contact with questions. Update the status badge and background colour as your work progresses.
51+
52+
**Stay organised** by using separate pages for different sections of your app, custom components, and sketches. Use Figma's unlimited pages feature to break apart main sections when needed. Lay out frames horizontally with consistent top alignment and equal spacing. Organise page variations vertically under the related main page to help teams switch between files easily.
53+
54+
## Design Tips
55+
56+
**Understanding clickbounds** — When you start using Figma, you might wonder why some components like buttons have larger bounding boxes than their visual appearance. This happens because of hidden clickbound layers (48px height) that follow WCAG guidelines for touch targets. This ensures your designs meet accessibility standards.
57+
58+
**Working with placeholders** — Use placeholders when content isn't ready, as they're built into many EDS components. When your content is ready, replace placeholders by dragging new components over them while holding:
59+
60+
- Mac: `Ctrl + Cmd`
61+
- PC: `Ctrl + Alt`
62+
63+
## EDS Designer Sandbox
64+
65+
The EDS designer sandbox in Figma provides a collaborative space where designers can share projects, explore ideas, and connect with the EDS core team. This community-driven environment helps foster innovation and ensures the design system continues to evolve based on real user needs.
66+
67+
You can **[visit the sandbox](https://www.figma.com/design/hjpavZkeUoRfn1N7mhIniK/EDS-designer-sandbox?node-id=7517-2865&p=f&t=EDrTGNK3eP4VnxYq-11)** to explore ongoing projects and connect with other designers working with EDS. If you have ideas for new components or improvements to the design system, you can **[request new features](../../../support/support.md)** through our support channels.
Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
title: Getting started with design
3+
---
4+
5+
You're ready to start designing with EDS. This guide helps you set up Figma access, understand our design workflow, and create your first designs with confidence.
6+
7+
**Prerequisites:** Equinor Figma account access
8+
**Time to get started:** 5-10 minutes
9+
10+
## Figma Setup
11+
12+
You'll need Figma access to work with EDS design components and libraries:
13+
14+
**Get Figma access** — Apply through internal Equinor resources or contact your team administrator for help with account setup.
15+
16+
**Join your design team** — Contact your team admin to join an existing team, or search for your team in Figma and request access.
17+
18+
For detailed setup instructions, permissions guidance, and workspace organisation, see our [complete Figma guide](figma.md).
19+
20+
## Start Designing
21+
22+
Once you have Figma access, follow these specific steps to create your first EDS design:
23+
24+
**1. Configure your Figma workspace**
25+
26+
- Open Figma preferences and change nudge amount to 8px (matches EDS grid system)
27+
- Enable the EDS component library in your file's Assets panel
28+
- Create a new frame using standard screen sizes (1440px width for desktop)
29+
30+
**2. Build your first interface**
31+
32+
- Start with layout components like `TopBar` or `SideSheet` for navigation
33+
- Add content using `Typography` components for headings and body text
34+
- Include interactive elements like `Button` or `TextField` components
35+
- Use `Icon` components from the EDS icon library for visual elements
36+
37+
**3. Apply EDS design principles**
38+
39+
- Use the 8px grid system for consistent spacing between elements
40+
- Apply colour tokens for backgrounds, text, and interactive states
41+
- Ensure minimum 3:1 contrast ratio for text (use EDS colour combinations)
42+
- Set focus states for all interactive elements
43+
44+
**4. Test your design**
45+
46+
- Preview your design using Figma's prototype mode
47+
- Check that all interactive elements have proper spacing (minimum 44px touch targets)
48+
- Verify colour contrast meets accessibility standards
49+
50+
For detailed component usage, workspace setup, file organisation, and advanced Figma techniques, see our [complete Figma guide](figma.md).
51+
52+
## Next Steps
53+
54+
Ready to advance your EDS skills? Here are specific next steps to help you grow:
55+
56+
- **Explore advanced components** — Try data visualisation, navigation, or form components for complex interfaces
57+
- **Join design community channels** — Connect with other designers using EDS and share experiences
58+
- **Propose new components** — Submit requests for components not currently in the system
59+
- **Create design variations** — Learn to customise components whilst maintaining consistency
60+
61+
Need help? Visit our [Support page](../../../support/support.md) for community channels and office hours.
Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Citizen Developers
2+
3+
You can create professional, brand-aligned solutions using low-code tools whilst maintaining the consistency and quality that EDS provides. Our Power Platform integration works seamlessly with the Microsoft 365 tools you already use daily.
4+
5+
## Getting Started
6+
7+
We've made it straightforward to begin building with EDS. You can be up and running in just a few minutes by following these steps:
8+
9+
1. **Access Power Apps** through your Microsoft 365 account
10+
2. **Download EDS templates** from the links provided below
11+
3. **Import templates** into your development environment or workspace
12+
4. **Start building** using pre-configured components and layouts
13+
14+
## Available Tools
15+
16+
### Power Apps
17+
18+
<!-- markdownlint-disable-next-line MD033 -->
19+
We offer a Power Apps canvas app template with pre-configured components, layout, theming, and interaction patterns aligned to the <abbr title="Equinor Design System">EDS</abbr> guidelines as far as the platform allows. Embedded in-app documentation covers usage, configuration, accessibility, and extension points so you can adapt safely without breaking consistency.
20+
21+
* Uses EDS colour, spacing, and typography tokens where technically supported
22+
* Includes common screen patterns (dashboard, form, list, detail)
23+
* Provides accessible defaults (labels, focus order, contrast guidance)
24+
* Exposes clearly named components for reuse and replacement
25+
* Documents customisation boundaries and recommended extension steps
26+
27+
Start by importing the template, reviewing the built-in guidance, and then tailoring the documented configuration areas to keep solutions maintainable and compliant.
28+
29+
**Preview the template**: [Canvas Apps Template](https://apps.equinor.com/edspowerapps) (Equinor users only)
30+
31+
**Template available**: [EDS Template download and importing instructions](https://apps.equinor.com/edspadl) (Equinor users only)
32+
33+
### Power BI
34+
35+
We offer light-themed templates covering common business scenarios, with pre-configured charts, layouts, and styling that align with EDS principles. These templates ensure your dashboards maintain consistent visual presentation across all your business intelligence solutions.
36+
37+
**Preview the template**: [Power BI Preview](https://apps.equinor.com/edspbi)
38+
39+
**Template available**: [Power BI EDS Template (PBIX)](pathname:///assets/eds-pbi-template-v2.pbix)
40+
41+
**Theme available**: [Power BI EDS Theme (JSON)](pathname:///assets/eds-pbi-theme-v2.json)
42+
43+
We're continuously expanding this collection with more examples and scenarios to support your diverse reporting needs.
44+
45+
## Best Practices
46+
47+
- Use provided templates as your foundation rather than starting from scratch
48+
- Follow EDS colour and typography guidelines when customising elements
49+
- Test your solutions across different devices to ensure responsive behaviour
50+
- Ensure proper colour contrast in all custom elements
51+
- Include alternative text for images and visual components
52+
- Test keyboard navigation functionality
53+
54+
## Getting Support
55+
56+
Connect with other citizen developers through internal Power Platform channels and join our regular office hours for hands-on help with your projects. Whether you need assistance with templates, components, or brand compliance, we're here to help.
57+
58+
For comprehensive support information and contact details, visit our [Support page](../../../support/support.md).
59+
60+
## Next Steps
61+
62+
Once you're comfortable with basic template usage, explore advanced customisation options and learn about creating reusable components for your team. We encourage you to contribute feedback to help us continuously improve EDS templates and resources for the entire citizen developer community.
Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
title: Getting started with development
3+
---
4+
5+
import Prerequisites from '@site/src/components/Prerequisites';
6+
7+
Welcome to building with EDS! Get production-ready React components, full TypeScript support, and everything you need to create consistent, accessible applications.
8+
9+
**Prerequisites:** <Prerequisites minimal />
10+
**Time to get started:** 10-15 minutes
11+
12+
## Getting Started
13+
14+
Install the core React components:
15+
16+
```bash
17+
npm install @equinor/eds-core-react
18+
# or
19+
yarn add @equinor/eds-core-react
20+
```
21+
22+
Import and use components in your React application:
23+
24+
```tsx
25+
import { Button, Typography } from '@equinor/eds-core-react'
26+
27+
function App() {
28+
return (
29+
<div>
30+
<Typography variant="h1">Welcome to EDS</Typography>
31+
<Button variant="contained">Get Started</Button>
32+
</div>
33+
)
34+
}
35+
```
36+
37+
For consistent styling, install and use design tokens:
38+
39+
```bash
40+
npm install @equinor/eds-tokens
41+
```
42+
43+
```javascript
44+
import { tokens } from '@equinor/eds-tokens'
45+
46+
const { typography, colors } = tokens
47+
48+
const styles = {
49+
fontSize: typography.heading.h1.fontSize,
50+
color: colors.interactive.primary__resting.rgba,
51+
}
52+
```
53+
54+
## Key Features
55+
56+
**TypeScript support:** Full autocomplete, type checking, and inline documentation included.
57+
58+
**Accessibility built-in:** Every component follows WCAG 2.1 AA standards with semantic HTML structure, keyboard navigation, proper colour contrast, and screen reader compatibility.
59+
60+
**Complete documentation:** Each component includes prop definitions, TypeScript types, interactive examples, and accessibility considerations.
61+
62+
## Common Issues
63+
64+
**TypeScript errors:** Check import paths and ensure TypeScript version is <Prerequisites />
65+
**Build issues:** Verify peer dependencies match requirements
66+
**Runtime problems:** Confirm styled-components version compatibility
67+
68+
Need help? Visit our [Support page](../../../support/support.md) for GitHub repository, community discussions, and office hours.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Getting started
2+
3+
Ready to start building with EDS?<br /><br />
4+
Whether you're designing in Figma, developing with React, or building solutions with low-code tools, we've created tailored guidance to help you succeed.
5+
6+
Choose your role below to jump straight into the resources and steps that matter most for your work.
7+
8+
## Choose Your Path
9+
10+
**As a designer**, you'll work with our Figma component libraries and design tokens. Access comprehensive documentation, usage guidelines, and accessibility considerations that help you create inclusive designs that translate smoothly to development. [Start your design journey ›](./design/getting_started_design.md)
11+
12+
**As a developer**, install our React component library via `npm` and start building with production-ready components. You'll get full TypeScript support, thorough documentation, and practical examples for proper implementation. [Get coding with EDS ›](./develop/getting_started_development.md)
13+
14+
**As a citizen developer**, explore our Power Platform templates and component libraries. Use ready-made templates for Power Apps and Power BI that follow EDS principles, helping you create professional solutions with familiar low-code tools. [Build with Power Platform ›](./develop/citizen_developers.md)
15+
16+
**As a team or project lead**, start with our contribution guidelines and join our community channels. Connect with other teams, access regular office hours, and learn about upcoming features that benefit your projects. [Lead with EDS ›](team_roles.md)
17+
18+
## What's Next
19+
20+
After you're comfortable with the basics, explore advanced topics like custom theming, contributing new components, or integrating EDS into existing projects through our [community channels](../../support/support.md).

0 commit comments

Comments
 (0)