Skip to content

Commit b4d03ec

Browse files
authored
chore(about): format and add link to project section (#2575)
1 parent 85549b3 commit b4d03ec

File tree

4 files changed

+96
-41
lines changed

4 files changed

+96
-41
lines changed

docsy.dev/.prettierignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# cSpell:ignore lookandfeel
22

33
/content/**/*.*
4+
!/content/en/about/**/*.*
45
!/content/en/blog/**/*.*
56
!/content/en/community/**/*.*
67
!/content/en/docs/_index.md

docsy.dev/config/_default/params.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
# status: archived # Then fetch include
88

99
version: &docsyVersion 0.14.3-dev
10-
tdBuildId: 015-over-main-e4c11620
10+
tdBuildId: 016-over-main-85549b3d
1111
versionLatest: &versionLatest v0.14.3
1212
version_menu: *docsyVersion
1313
version_menu_pagelinks: true

docsy.dev/content/en/about/index.md

Lines changed: 93 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ linkTitle: About
44
description: >-
55
Docsy is a pre-configured Hugo theme that provides the core features and
66
behaviors needed to create a technical documentation site
7-
menu: {main: {weight: 10}}
7+
menu: { main: { weight: 10 } }
88
---
99

1010
{{% blocks/cover
@@ -21,29 +21,57 @@ menu: {main: {weight: 10}}
2121

2222
{{% blocks/section color="white" %}}
2323

24-
Use Docsy to set up your documentation website, including an optional Blog section, and then spend your time focusing on authoring technical content. Depending on how you choose to configure Docsy and whether you use a hosting service that supports continuous builds, you can even just add your Markdown or HTML content file into a folder on your source repository, and then sit back while it automatically gets added to your site - complete with updated menus.
24+
Use Docsy to set up your documentation website, including an optional Blog
25+
section, and then spend your time focusing on authoring technical content.
26+
Depending on how you choose to configure Docsy and whether you use a hosting
27+
service that supports continuous builds, you can even just add your Markdown or
28+
HTML content file into a folder on your source repository, and then sit back
29+
while it automatically gets added to your site - complete with updated menus.
2530

26-
Read on to find out more, or visit our [documentation](/docs/) to get started!
31+
To find out more, read on, or skip to the [documentation](/docs/). For project
32+
details, see the [project](/project/) page.
2733

2834
## So what’s a technical documentation site?
2935

30-
A technical documentation site is a website that your users can visit to find the documentation for your technical project. Your documentation set contains all the information you think your users might need to engage with your project, from overviews that help them understand what the project is for, to instructions for specific tasks. Depending on the size of the project, a documentation set can be a page or two or an entire “book” with different types of information.
31-
32-
**Most users don’t want to have to spend much time looking at docs - they want to try your great project!** So how do you make sure your technical documentation set gives users what they need to easily understand your project and get things done? We think a good technical documentation set should be:
33-
34-
* **Reliable**: Is it true?
35-
* **Comprehensive**: Does it have all the information your target users might need?
36-
* **Well-organized and navigable**: Can the user find the information they need? Are similar types of information (all the information about a feature, all your reference information) grouped together?
37-
38-
If you have users around the world, you might also want to provide your content in multiple languages, and if you have an open source project, you’ll probably want your users to be able to contribute to the docs.
39-
40-
Once you have your content, you use a technical documentation site to publish your technical documentation set online for your users. In addition to your documentation, your site might also contain material like contact information, a blog, or information about how to contribute to the project.
36+
A technical documentation site is a website that your users can visit to find
37+
the documentation for your technical project. Your documentation set contains
38+
all the information you think your users might need to engage with your project,
39+
from overviews that help them understand what the project is for, to
40+
instructions for specific tasks. Depending on the size of the project, a
41+
documentation set can be a page or two or an entire “book” with different types
42+
of information.
43+
44+
**Most users don’t want to have to spend much time looking at docs - they want
45+
to try your great project!** So how do you make sure your technical
46+
documentation set gives users what they need to easily understand your project
47+
and get things done? We think a good technical documentation set should be:
48+
49+
- **Reliable**: Is it true?
50+
- **Comprehensive**: Does it have all the information your target users might
51+
need?
52+
- **Well-organized and navigable**: Can the user find the information they need?
53+
Are similar types of information (all the information about a feature, all
54+
your reference information) grouped together?
55+
56+
If you have users around the world, you might also want to provide your content
57+
in multiple languages, and if you have an open source project, you’ll probably
58+
want your users to be able to contribute to the docs.
59+
60+
Once you have your content, you use a technical documentation site to publish
61+
your technical documentation set online for your users. In addition to your
62+
documentation, your site might also contain material like contact information, a
63+
blog, or information about how to contribute to the project.
4164

4265
## How does Docsy help?
4366

44-
Particularly when working with open source projects, it can be difficult to figure out how to turn all your product knowledge into a website that helps and engages your users. **Enter Docsy!**
67+
Particularly when working with open source projects, it can be difficult to
68+
figure out how to turn all your product knowledge into a website that helps and
69+
engages your users. **Enter Docsy!**
4570

46-
Docsy gives you a theme for the [Hugo](https://gohugo.io/) static site generator, an established open source tool that builds ready-to-serve websites from a set of theme and content files. The Docsy theme provides you with useful stuff for a technical documentation site that *isn’t* your own content:
71+
Docsy gives you a theme for the [Hugo](https://gohugo.io/) static site
72+
generator, an established open source tool that builds ready-to-serve websites
73+
from a set of theme and content files. The Docsy theme provides you with useful
74+
stuff for a technical documentation site that _isn’t_ your own content:
4775

4876
<table>
4977
<tr>
@@ -92,51 +120,77 @@ Docsy gives you a theme for the [Hugo](https://gohugo.io/) static site generator
92120

93121
### Simple authoring and publishing
94122

95-
Author your content in the Markdown or HTML and then immediately test it with Hugo's local server. Once you are ready to
96-
publish, add that content to your project and deploy it to your site using any of Hugo’s supported options.
123+
Author your content in the Markdown or HTML and then immediately test it with
124+
Hugo's local server. Once you are ready to publish, add that content to your
125+
project and deploy it to your site using any of Hugo’s supported options.
97126
[Learn more...](/docs/deployment/)
98127

99128
### Built-in integration with common tools
100129

101-
The Docsy template currently includes built-in integration with the following tools:
102-
103-
* [**GitHub**](https://github.com): Get in-page links directly to your GitHub repo and provide your users with a
104-
convenient pathway to providing feedback, opening issues, and even suggesting changes through Pull Requests.
105-
* [**Google Analytics**](https://analytics.google.com/analytics/web/): Easily connect your Google Analytics account to your
106-
site.
107-
* [**Google Custom Search**](https://cse.google.com/cse/): Use Google Custom Search for in-site search queries, or
108-
configure your site to search the web.
109-
* [**Algolia DocSearch**](https://docsearch.algolia.com): Let your users search your site with Algolia DocSearch.
110-
* [**Lunr**](https://lunrjs.com/): Local indexing and search for your site without the need for external search services.
130+
The Docsy template currently includes built-in integration with the following
131+
tools:
132+
133+
- [**GitHub**](https://github.com): Get in-page links directly to your GitHub
134+
repo and provide your users with a convenient pathway to providing feedback,
135+
opening issues, and even suggesting changes through Pull Requests.
136+
- [**Google Analytics**](https://analytics.google.com/analytics/web/): Easily
137+
connect your Google Analytics account to your site.
138+
- [**Google Custom Search**](https://cse.google.com/cse/): Use Google Custom
139+
Search for in-site search queries, or configure your site to search the web.
140+
- [**Algolia DocSearch**](https://docsearch.algolia.com): Let your users search
141+
your site with Algolia DocSearch.
142+
- [**Lunr**](https://lunrjs.com/): Local indexing and search for your site
143+
without the need for external search services.
111144

112145
### Make it your own
113146

114-
You can configure the Docsy theme as much or as little as you like, anything from changing the colors and images to adding your own type of page layout. [Learn more...](/docs/content/lookandfeel/)
147+
You can configure the Docsy theme as much or as little as you like, anything
148+
from changing the colors and images to adding your own type of page layout.
149+
[Learn more...](/docs/content/lookandfeel/)
115150

116151
### Get organized
117152

118-
We believe a well-organized documentation set can really help your users find the information they need, when they need it - whether it’s a “Hello World” tutorial when they’re starting out or a single core task they need to do to finish a complicated app. We also believe that having well-organized docs helps you create comprehensive docs, as it’s easier to see when you’re missing something important. [Learn more...](/docs/best-practices/organizing-content/)
153+
We believe a well-organized documentation set can really help your users find
154+
the information they need, when they need it - whether it’s a “Hello World”
155+
tutorial when they’re starting out or a single core task they need to do to
156+
finish a complicated app. We also believe that having well-organized docs helps
157+
you create comprehensive docs, as it’s easier to see when you’re missing
158+
something important. [Learn more...](/docs/best-practices/organizing-content/)
119159

120-
Docsy also provides autogenerated site navigation based on how you organize your source files, so once you’ve organized your docs in folders in GitHub or other source control, you’ve got menus for your users to quickly reach the doc they need. [Learn more...](/docs/content/navigation/)
160+
Docsy also provides autogenerated site navigation based on how you organize your
161+
source files, so once you’ve organized your docs in folders in GitHub or other
162+
source control, you’ve got menus for your users to quickly reach the doc they
163+
need. [Learn more...](/docs/content/navigation/)
121164

122165
### Keep up to date
123166

124-
Spend time setting up your technical documentation site once, and then focus on what you do best. We work closely with
125-
the Hugo team and have individuals actively maintaining the Docsy theme. You can easily get and
126-
apply Docsy updates to your site, as well as open feature requests to improve the
127-
template, or even add new behaviors. [Learn more...](/docs/updating/)
167+
Spend time setting up your technical documentation site once, and then focus on
168+
what you do best. We work closely with the Hugo team and have individuals
169+
actively maintaining the Docsy theme. You can easily get and apply Docsy updates
170+
to your site, as well as open feature requests to improve the template, or even
171+
add new behaviors. [Learn more...](/docs/updating/)
128172

129173
### Focus on great content
130174

131-
Because Docsy helps you create and serve a well-organized, navigable technical documentation set, it frees you up to create and maintain great reliable, comprehensive content that your users can enjoy and trust.
175+
Because Docsy helps you create and serve a well-organized, navigable technical
176+
documentation set, it frees you up to create and maintain great reliable,
177+
comprehensive content that your users can enjoy and trust.
132178

133179
## What's next for Docsy?
134180

135-
Docsy is an open source project and we love getting patches and contributions to make Docsy and its docs even better. We hope to continue to make improvements to the theme along with the Docsy community.
181+
Docsy is an open source project and we love getting patches and contributions to
182+
make Docsy and its docs even better. We hope to continue to make improvements to
183+
the theme along with the Docsy community.
184+
185+
Visit our [Issues](https://github.com/google/docsy/issues) to see what we're
186+
currently working on. If there's something you'd like to see in Docsy, please
187+
create an issue yourself - or assign yourself an issue if you'd like to fix or
188+
add something! See our [contribution guidelines](/docs/contribution-guidelines/)
189+
for more information.
136190

137-
Visit our [Issues](https://github.com/google/docsy/issues) to see what we're currently working on. If there's something you'd like to see in Docsy, please create an issue yourself - or assign yourself an issue if you'd like to fix or add something! See our [contribution guidelines](/docs/contribution-guidelines/) for more information.
191+
You can find out how to update your site to the latest version of Docsy in
192+
[Keeping the theme up to date](/docs/updating/).
138193

139-
You can find out how to update your site to the latest version of Docsy in [Keeping the theme up to date](/docs/updating/).
140194
<!-- There must not be a blank line at the end of this file otherwise it creates an empty paragraph in the rendered page -->
141195

142196
{{% /blocks/section %}}

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "docsy",
3-
"version": "0.14.3-dev+015-over-main-e4c11620",
3+
"version": "0.14.3-dev+016-over-main-85549b3d",
44
"repository": "github:google/docsy",
55
"homepage": "https://www.docsy.dev",
66
"license": "Apache-2.0",

0 commit comments

Comments
 (0)