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

fix: broken links 🐛 #75

Merged
merged 1 commit into from
Sep 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
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
4 changes: 2 additions & 2 deletions src/concepts/application-patterns/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Application Patterns

(Stub) This page covers several patterns one can use for their application and acts as a top-level
page for the following articles where these patterns are gone into more in-depth.
This page covers several patterns one can use for their application and acts as a top-level page for
the following articles where these patterns are gone into more in-depth.

- [The Elm Architecture](./the-elm-architecture.md)
- [Component Architecture](./component-architecture.md)
Expand Down
16 changes: 8 additions & 8 deletions src/how-to/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# How To

- [Layout UIs](./layout/README.md): Articles regarding how to layout your application's User
Interface including widgets and nesting blocks
- [Render Text](./render/README.md): Articles related to actually rendering test and widgets to the
screen including how to style and write to the buffer.
- [Use Widgets](./widgets/README.md): Articles related to using individual widgets suchs as the
paragraph, block, and creating your own custom widget.
- [Develop Applications](./develop-apps/README.md): Articles related to developing applications.
E.g. how to handle cli arguments, tracing, configuration, panics, etc.
- [Layout UIs](./layout/): Articles regarding how to layout your application's User Interface
including widgets and nesting blocks
- [Render Text](./render/): Articles related to actually rendering test and widgets to the screen
including how to style and write to the buffer.
- [Use Widgets](./widgets/): Articles related to using individual widgets suchs as the paragraph,
block, and creating your own custom widget.
- [Develop Applications](./develop-apps/): Articles related to developing applications. E.g. how to
handle CLI arguments, tracing, configuration, panics, etc.
2 changes: 1 addition & 1 deletion src/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,4 +70,4 @@ ratatui = { version = "0.23", default-features = false, features = ["termion"] }
termwiz = "0.20.0"
```

[Backend]: ./concepts/backends/README.md
[Backend]: ./concepts/backends/
16 changes: 8 additions & 8 deletions src/tutorial/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Tutorial

- [Hello World](./hello-world/README.md): This tutorial takes you through the basics of creating a
simple Ratatui application that displays "Hello World".
- [Counter App](./counter-app/README.md): This tutorial will set up the basics of a `ratatui`
project by building a app that displays a counter.
- [JSON Editor](./json-editor/README.md): This tutorial will guide you through setting up a Rust
project and organizing its structure for a `ratatui`-based application to edit json key value
pairs. JSON Editor TUI will provide an interface for users to input key-value pairs, which are
then converted into correct JSON format and printed to stdout.
- [Hello World](./hello-world/): This tutorial takes you through the basics of creating a simple
Ratatui application that displays "Hello World".
- [Counter App](./counter-app/): This tutorial will set up the basics of a `ratatui` project by
building a app that displays a counter.
- [JSON Editor](./json-editor/): This tutorial will guide you through setting up a Rust project and
organizing its structure for a `ratatui`-based application to edit json key value pairs. JSON
Editor TUI will provide an interface for users to input key-value pairs, which are then converted
into correct JSON format and printed to stdout.
- [Async Counter App](./counter-async-app/): This tutorial, expands on the Counter app to build a an
async TUI using [tokio](https://tokio.rs/).
- [Stopwatch App](./stopwatch-app/): This tutorial will build a working stopwatch application that
Expand Down
5 changes: 2 additions & 3 deletions src/tutorial/json-editor/closing_thoughts.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,8 @@
This tutorial should get you started with a basic understanding of the flow of a `ratatui` program.
However, this is only _one_ way to create a `ratatui` application. Because `ratatui` is relatively
low level compared to other UI frameworks, almost any application model can be implemented. You can
explore more of these in [Concepts: Application
Patterns](../../concepts/application-patterns/README.md) and get some inspiration for what model
will work best for your application.
explore more of these in [Concepts: Application Patterns](../../concepts/application-patterns/) and
get some inspiration for what model will work best for your application.

## Finished Files

Expand Down