Skip to content
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.

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

docs: Merge intro into index #1234

Merged
merged 4 commits into from
Aug 27, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
11 changes: 10 additions & 1 deletion docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@ plugins:
# Redirect old links to new ones.
- redirects:
redirect_maps:
intro.md: index.md
value-groups.md: value-groups/index.md


Expand Down Expand Up @@ -121,6 +122,15 @@ markdown_extensions:
kwds:
case: lower

# :foo-bar: emoji syntax.
#
# See https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/
# to search through available emojis.
# The emojis are rendered into inline svgs at build time.
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg

# GitHub-style task lists.
- pymdownx.tasklist:
custom_checkbox: true # recommended
Expand All @@ -141,7 +151,6 @@ nav:
- get-started/another-handler.md
- get-started/many-handlers.md
- get-started/conclusion.md
- intro.md
- Concepts:
- Container: container.md
- Lifecycle: lifecycle.md
Expand Down
35 changes: 30 additions & 5 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,44 @@ Fx is **a dependency injection system for Go**.

- **Eliminate globals**

Fx helps you remove global state from your application.
No more `init()` or global variables.
Use Fx-managed singletons.
---

By using Fx-managed singletons,
you can eliminate global state from your application.
With Fx, you don't have to rely on `init()` functions for setup,
instead relying on Fx's to manage the lifecycle of your application.
abhinav marked this conversation as resolved.
Show resolved Hide resolved

- **Reduce boilerplate**

---

Fx reduces the amount of code copy-pasted across your services.
It lets you define shared application setup and in a single place,
abhinav marked this conversation as resolved.
Show resolved Hide resolved
and then reuse it across all your services.

- **Automatic plumbing**

---

Fx automatically constructs your application's dependency graph.
A component added to the application can be used by any other component
without any additional configuration.

[Learn more about the dependency container :material-arrow-right:](container.md)

- **Code reuse**

---

Fx lets teams within your organization build loosely-coupled
and well-integrated shareable components.
and well-integrated shareable components referred to as modules.

[Learn more about modules :material-arrow-right:](modules.md)

- **Battle-tested**

Fx is the backbone of nearly all Go services at Uber.

</div>

[Get started](get-started/index.md){ .md-button .md-button--primary }
[Get started :material-arrow-right-bold:](get-started/index.md){ .md-button .md-button--primary }
12 changes: 0 additions & 12 deletions docs/src/intro.md

This file was deleted.