Skip to content

Commit

Permalink
Merge pull request #342 from feature-sliced/feature/DISCOVERY-321-res…
Browse files Browse the repository at this point in the history
…truct--guides

DISCOVERY-321: Restructure of docs - 🎯 Guides
  • Loading branch information
azinit authored Nov 7, 2021
2 parents 875f8d8 + fee40b9 commit f9d8a5a
Show file tree
Hide file tree
Showing 75 changed files with 1,023 additions and 823 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ If there are variations, how best to place indents-welcome:)
[refs-splitting-slices]: https://feature-sliced.design/docs/concepts/app-splitting#group-slices
[refs-splitting-segments]: https://feature-sliced.design/docs/concepts/app-splitting#group-segments

[refs-migration-v1]: https://feature-sliced.design/docs/guides/migration-from-v1
[refs-migration-v1]: https://feature-sliced.design/docs/guides/migration/from-v1

[ext-ubiq-lang]: https://thedomaindrivendesign.io/developing-the-ubiquitous-language
[ext-fdd]: https://github.com/feature-sliced/documentation/tree/rc/feature-driven
Expand Down
14 changes: 11 additions & 3 deletions website/i18n/en/docusaurus-plugin-content-docs/current.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,17 @@
"message": "Examples",
"description": "The label for category Examples in sidebar guidesSidebar"
},
"sidebar.guidesSidebar.category.Handbook": {
"message": "Handbook",
"description": "The label for category Handbook in sidebar guidesSidebar"
"sidebar.guidesSidebar.category.Migration": {
"message": "Migration",
"description": "The label for category Migration in sidebar guidesSidebar"
},
"sidebar.guidesSidebar.category.Tech": {
"message": "Tech",
"description": "The label for category Tech in sidebar guidesSidebar"
},
"sidebar.conceptsSidebar.category.Issues": {
"message": "Issues",
"description": "The label for category Issues in sidebar conceptsSidebar"
},
"sidebar.referenceSidebar.category.Layer": {
"message": "Layer",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ sidebar_position: 0
sidebar_class_name: sidebar-item--root
hide_table_of_contents: true
slug: /about
pagination_prev: reference/knowledge-types
pagination_prev: reference/index
---

# 🍰 About
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ However, as a result of [discussions and analysis of extensive experience][disc-

[ref-layers]: /docs/reference/layers/overview
[ref-segments]: /docs/reference/segments
[ref-low-coupling]: /docs/guides/low-coupling
[ref-low-coupling]: /docs/concepts/low-coupling
[ref-grouping]: /docs/reference/layers/features#structural-grouping-features

[disc-src]: https://github.com/feature-sliced/documentation/discussions/31
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,4 +73,4 @@ Violation of this rule is a signal of problems:

[refs-public-api]: /docs/concepts/public-api
[refs-splitting]: /docs/concepts/app-splitting
[refs-low-coupling]: /docs/guides/low-coupling
[refs-low-coupling]: /docs/concepts/low-coupling
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ sidebar_position: 0
sidebar_class_name: sidebar-item--root
hide_table_of_contents: true
slug: /concepts
pagination_prev: guides/usage-with-nextjs
pagination_prev: guides/index
---

# 🧩 Concepts
Expand All @@ -17,7 +17,7 @@ A section with key concepts of the methodology, for an advanced understanding of
## Main

import Row from "@site/src/shared/ui/row/tmpl.mdx"
import { BlockOutlined, ApiOutlined, ApartmentOutlined } from "@ant-design/icons";
import { BlockOutlined, ApiOutlined, ApartmentOutlined, PartitionOutlined, NodeIndexOutlined } from "@ant-design/icons";

<Row
title="App splitting"
Expand All @@ -37,3 +37,15 @@ import { BlockOutlined, ApiOutlined, ApartmentOutlined } from "@ant-design/icons
to="/docs/concepts/cross-communication"
Icon={ApartmentOutlined}
/>
<Row
title="Decouple entities"
description="Decomposition of logic with allocation of business entities"
to="/docs/concepts/decouple-entities"
Icon={PartitionOutlined}
/>
<Row
title="Desegmented"
description="The problem of redundant desegmentation of logic"
to="/docs/concepts/issues/desegmented"
Icon={NodeIndexOutlined}
/>
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
label: Issues
position: 10
collapsed: false
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 1
sidebar_position: 4
sidebar_class_name: sidebar-item--wip
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,7 @@ Such name collisions can negatively affect the development process.

[refs-layers]: /docs/reference/layers/overview
[refs-segments]: /docs/reference/segments
<!-- FIXME: Refer to the root later, not to the first element -->
[refs-reference]: /docs/reference/glossary
[refs-reference]: /docs/reference

[disc-src]: https://github.com/feature-sliced/documentation/discussions/16
[disc-naming]: https://github.com/feature-sliced/documentation/discussions/31#discussioncomment-464894
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ In most cases, [it is recommended][ext-disc-api] to place `api` and `config` onl

[ext-disc-api]: https://github.com/feature-sliced/documentation/discussions/66

[refs-concepts]: /docs/concepts/architecture
[refs-concepts]: /docs/concepts
[refs-public-api]: /docs/concepts/public-api
[refs-isolation]: /docs/concepts/cross-communication
[refs-needs-driven]: /docs/concepts/needs-driven
Expand All @@ -133,5 +133,5 @@ In most cases, [it is recommended][ext-disc-api] to place `api` and `config` onl
[refs-splitting-slices]: /docs/concepts/app-splitting#group-slices
[refs-splitting-segments]: /docs/concepts/app-splitting#group-segments

[refs-guides]: /docs/guides/migration-from-v1
[refs-low-coupling]: /docs/guides/low-coupling
[refs-guides]: /docs/guides
[refs-low-coupling]: /docs/concepts/low-coupling
Original file line number Diff line number Diff line change
Expand Up @@ -50,15 +50,15 @@ There are only such ones in the public domain so far, not all of them have been

### The project is written on feature-slices v1, how to update and is it worth it?

Answered [here](/docs/guides/migration-from-v1)
Answered [here](/docs/guides/migration/from-v1)

### Can I embed pages/features/entities into each other?

Answered [here](/docs/concepts/app-splitting#group-slices)

### How do I work with the authorization context?

Answered [here](/docs/guides/examples/viewer)
Answered [here](/docs/guides/examples/auth)

### What about Atomic Design?

Expand All @@ -73,7 +73,7 @@ At the same time, Atomic Design [is well applied](https://t.me/feature_sliced/16
- `Feature` - business feature, **action on an entity**
- create-blog-post / login-by-oauth / edit-account / publish-video / ...

See also [comparison reference] (/docs/reference/layers/overview), [viewer implementation of logic by layers](/docs/guides/examples/viewer)
See also [comparison reference] (/docs/reference/layers/overview), [viewer implementation of logic by layers](/docs/guides/examples/auth)

### Where to store the layout/template of pages?

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -837,11 +837,9 @@ Below in [Codesandbox][ext-sandbox] is an example of the resulting TodoApp, wher
[refs-public-api]: /docs/concepts/public-api
[refs-splitting]: /docs/concepts/app-splitting

[refs-low-coupling]: /docs/guides/low-coupling
<!-- FIXME: Ссылаться на рут позднее, а не на первый элемент -->
[refs-guides]: /docs/guides/migration-from-v1
<!-- FIXME: Ссылаться на рут позднее, а не на первый элемент -->
[refs-reference]: /docs/reference/glossary
[refs-low-coupling]: /docs/concepts/low-coupling
[refs-guides]: /docs/guides
[refs-reference]: /docs/reference
[refs-layers]: /docs/reference/layers/overview
[refs-app]: /docs/reference/layers/app
[refs-pages]: /docs/reference/layers/pages
Expand Down
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
label: Examples
position: 1
collapsed: false
Loading

0 comments on commit f9d8a5a

Please sign in to comment.