Skip to content
This repository was archived by the owner on Mar 16, 2026. It is now read-only.

Commit 9c63c17

Browse files
committed
docs: update introduction
1 parent 8c1e78d commit 9c63c17

File tree

2 files changed

+16
-13
lines changed

2 files changed

+16
-13
lines changed

src/docs/documentation/general/introduction.mdx

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,21 @@ menu: General
77

88
# Introduction
99

10-
Libraries that make our life easier coming up every day. Styleguides and design system are growing so fast. Today, tools that allow us to be quick and effective are really necessary. We can't lose time with tasks that should be trivial for us. Thinking about that **Docz** came out.
10+
Documenting code is one of the most important and time-heavy processes when developing software.
1111

12-
Documenting our things is one of the most important and heavy processes when you're creating something new. We waste a lot of time with unnecessary setups to build something that can represent and we want with our own style.
12+
A lot of time is spent on building and maintaining custom documentation sites.
13+
14+
**Docz** was created to solve this problem.
15+
16+
Docz enables you to quickly create live-reloading, seo-friendly, production-ready documentation sites with MDX and customize the look, feel and behavior when required by leveraging GatsbyJS and Gatsby theme shadowing.
1317

1418
## Principles
1519

16-
You have many options available when you want to create your own design system or even just document your project. Looking over these alternatives, we borrowed the best ideas from each and came up with these principles:
20+
We started by looking over the options available when you want to create your design system or document your project. We borrowed the best ideas from each and came up with the following guiding principles :
1721

18-
- **Zero config and easy to learn.** No unnecessary build steps with confusing setups.
22+
- **Zero config and easy to learn.** Avoid unnecessary build steps with confusing setups.
1923
- **Blazing fast.** Built with performance in mind from the start.
2024
- **Easy to customize.** Create something that will be easy to use and customize.
21-
- **MDX based.** The best standard for writing documentation.
22-
- **Pluggable.** Plugins are the best choice when you need a custom and flexible solution.
25+
- **MDX based.** Use the best standard for writing documentation.
2326

24-
Now you know the core principles of Docz. Let's [get started](/docs/getting-started)!
27+
Now that you know the core principles of Docz. Let's [get started](/docs/getting-started)!

src/theme/components/shared/Topbar/index.tsx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -85,13 +85,13 @@ export const TOPBAR_LINKS: MenuListItem[] = [
8585
{
8686
id: 2,
8787
children: 'Documentation',
88-
to: '/docs/introduction',
89-
},
90-
{
91-
id: 3,
92-
children: 'Plugins',
93-
to: '/plugins',
88+
to: '/docs/getting-started',
9489
},
90+
// {
91+
// id: 3,
92+
// children: 'Plugins',
93+
// to: '/plugins',
94+
// },
9595
{
9696
id: 4,
9797
children: 'Themes',

0 commit comments

Comments
 (0)