Skip to content

📁 content update: grammar, punctuation & spelling #5

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
merged 1 commit into from
Oct 27, 2022
Merged

📁 content update: grammar, punctuation & spelling #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
28 changes: 14 additions & 14 deletions content/docs/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,41 +6,41 @@ author = "Colin Wilson"
title = "Overview"
icon = "circle"
toc = true
# featured_image = "https://res.cloudinary.com/qunux/image/upload/v1617231239/pgp_keys-03_jjogys.svg"
# featured_image = ""
description = "Lotus Docs is a modern documentation theme built for Hugo."
publishdate = "2022-09-30T05:33:22+01:00"
tags = ["Beginners","Account"]
tags = ["Beginners"]
categories = [""]

[twitter]
card = "summary"
site = "@LotusLabsUK"
creator = "@LotusLabsUK"
title = "Getting started"
description = "Getting started with Lotus Labs"
image = "https://res.cloudinary.com/qunux/image/upload/v1617231350/pgp_keys-03_h0soqe.png"
site = "@LotusDocs"
creator = "@LotusDocs"
title = "What is Lotus Docs?"
description = "Overview of Lotus Docs"
image = ""
+++

{{< alert context="danger" >}}
Lotus Docs is currently in the very early stages of development and is therefore not ready for use in production. You're welcome to test the theme yourself and contributions to the project a very welcome.
Lotus Docs is currently in the very early stages of development and is, therefore, not ready for use in production. You're welcome to test the theme yourself, and contributions to the project a very welcome.
{{< /alert >}}

Welcome to the Lotus Docs user guide. This guide shows you how to get started creating technical documentation sites using Lotus Docs, including site customisation and how to use Lotus Docs' features and templates.
Welcome to the Lotus Docs user guide. This guide shows you how to start creating technical documentation sites using Lotus Docs, including site customisation and using Lotus Docs' features and templates.

## What is Lotus Docs?

Lotus Docs is a theme for the [Hugo](https://gohugo.io) static site generator that’s specifically designed for technical documentation sets and includes many best practices by default. Use Lotus Docs to get a working and reliable documentation site up and running fast, leaving valuable time to focus creating content for your users.
Lotus Docs is a theme for the [Hugo](https://gohugo.io) static site generator specifically designed for technical documentation sets and includes many best practices by default. Use Lotus Docs to get a working and reliable documentation site up and running fast, leaving valuable time to focus on creating content for your users.

The site you’re currently reading was built using the Lotus Docs theme! Many of the features and configurations availble in the Lotus Docs theme are on display here. You can clone this entire site and edit it to suit your own projects, or just explore the site, its source and see what Lotus Docs can do.
The site you’re currently reading was built using the Lotus Docs theme! Many of the features and configurations available in the Lotus Docs theme are on display here. You can clone this entire site and edit it to suit your projects, or explore the site, its source and see what Lotus Docs can do.

{{< alert context="warning" >}}
**Source hosting and management:** Our theme and [site source files](https://github.com/colinwilson/lotusdocs) live on GitHub, which is the simplest approach for most projects. However, you can also keep your project files in GitLab, BitBucket, locally, or wherever you like. Keep in mind that where your source files live may affect the Lotus Docs features you can use (such as letting users file documentation issues) and site deployment options.
**Source hosting and management:** Our theme and [site source files](https://github.com/colinwilson/lotusdocs) live on GitHub, which is the recommended approach for most projects. You can also keep your project files in GitLab, BitBucket, locally, or wherever you like. Be aware that where your source files live may affect the Lotus Docs features you can use (such as letting users file documentation issues) and site deployment options.

**Site deployment:** You can find out about deployment options in Previews and Deployment. This site uses [Vercel](https://vercel.com).
{{< /alert >}}

## Is Lotus Docs for me?

Lotus Docs is (currently) suited to small or medium technical documentation sets with 100 or less pages of docs. That's not to say Lotus Docs won't scale to larger documentation sets, just that its navigation and site structure may not be sufficient for larger data sets without heavy customisation.
Lotus Docs is (currently) suited to small or medium technical documentation sets with 100 or fewer pages of docs. That's not to say Lotus Docs won't scale to larger documentation sets, just that its navigation and site structure may not be sufficient for larger data sets without heavy customisation.

The good news is that development to accommodate larger sites is ongoing. So keep and eye on the [Lotus Docs GitHub repository](https://github.com/colinwilson/lotusdocs) for updates.
The good news is that development to accommodate such sites is ongoing. So keep an eye on the [Lotus Docs GitHub repository](https://github.com/colinwilson/lotusdocs) for updates.