Skip to content

Commit

Permalink
docs: update "getting-started" and "concepts" (cs3org#1609)
Browse files Browse the repository at this point in the history
Direct sentences towards users rather than developers, and remove
placeholder text.
  • Loading branch information
sudo-sturbia authored and fbx committed Apr 19, 2021
1 parent ae1d935 commit e4c3b3e
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 13 deletions.
12 changes: 1 addition & 11 deletions docs/content/en/docs/concepts/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,5 @@ title: "Concepts"
linkTitle: "Concepts"
weight: 10
description: >
What does your user need to understand about your project in order to use it - or potentially contribute to it?
What do you need to understand about Reva in order to use it - or potentially contribute to it?
---

{{% pageinfo %}}
This is a placeholder page that shows you how to use this template site.
{{% /pageinfo %}}

For many projects, users may not need much information beyond the information in the [Overview](/docs/overview/), so this section is **optional**. However if there are areas where your users will need a more detailed understanding of a given term or feature in order to do anything useful with your project (or to not make mistakes when using it) put that information in this section. For example, you may want to add some conceptual pages if you have a large project with many components and a complex architecture.

Remember to focus on what the user needs to know, not just what you think is interesting about your project! If they don’t need to understand your original design decisions to use or contribute to the project, don’t put them in, or include your design docs in your repo and link to them. Similarly, most users will probably need to know more about how features work when in use rather than how they are implemented. Consider a separate architecture page for more detailed implementation and system design information that potential project contributors can consult.


3 changes: 1 addition & 2 deletions docs/content/en/docs/getting-started/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,5 @@ title: "Getting Started"
linkTitle: "Getting Started"
weight: 2
description: >
What does your user need to know to try your project?
What do you need to know to try Reva?
---

0 comments on commit e4c3b3e

Please sign in to comment.