Skip to content

Commit

Permalink
fix: links
Browse files Browse the repository at this point in the history
  • Loading branch information
SychO9 committed Nov 5, 2024
1 parent 192c595 commit 4f2fb2e
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 19 deletions.
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Flarum is the combined successor of [esoTalk](https://github.com/esotalk/esoTalk

* **Beautiful and responsive.** This is forum software for humans. Flarum is carefully designed to be consistent and intuitive across platforms, out-of-the-box.

* **Powerful and extensible.** Customize, extend, and integrate Flarum to suit your community. Flarum’s architecture is amazingly flexible, with a [powerful Extension API](/extend/README.md).
* **Powerful and extensible.** Customize, extend, and integrate Flarum to suit your community. Flarum’s architecture is amazingly flexible, with a [powerful Extension API](./extend/README.md).

* **Free and open.** Flarum is released under the [MIT license](https://github.com/flarum/flarum/blob/master/LICENSE).

Expand Down
6 changes: 3 additions & 3 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Interested in contributing to Flarum development? That's great! From [opening a

Before contributing, please read the [code of conduct](code-of-conduct.md).

This document is a guide for developers who want to contribute code to Flarum. If you're just getting started, we recommend that you read the [Getting Started](/extend/start.md) documentation in the Extension docs to understand a bit more about how Flarum works.
This document is a guide for developers who want to contribute code to Flarum. If you're just getting started, we recommend that you read the [Getting Started](./extend/start.md) documentation in the Extension docs to understand a bit more about how Flarum works.

## Why Contribute to Flarum?

Expand Down Expand Up @@ -158,7 +158,7 @@ Flarum's CSS classes roughly follow the [SUIT CSS naming conventions](https://gi

### Translations

We use a [standard key format](/extend/i18n.md#appendix-a-standard-key-format) to name translation keys descriptively and consistently.
We use a [standard key format](./extend/i18n.md#appendix-a-standard-key-format) to name translation keys descriptively and consistently.

## Contributor License Agreement

Expand All @@ -168,4 +168,4 @@ You confirm that you are able to grant us these rights. You represent that You a

You represent that the Contributions are Your original works of authorship, and to Your knowledge, no other person claims, or has the right to claim, any right in any invention or patent related to the Contributions. You also represent that You are not legally obligated, whether by entering into an agreement or otherwise, in any way that conflicts with the terms of this license.

The Flarum Foundation acknowledges that, except as explicitly described in this Agreement, any Contribution which you provide is on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
The Flarum Foundation acknowledges that, except as explicitly described in this Agreement, any Contribution which you provide is on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
4 changes: 2 additions & 2 deletions docs/extend/frontend.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This page describes how to make changes to Flarum's user interface. How to add buttons, marquees, and blinking text. 🤩

[Remember](/extend/start.md#architecture), Flarum's frontend is a **single-page JavaScript application**. There's no Twig, Blade, or any other kind of PHP template to speak of. The few templates that are present in the backend are only used to render search-engine-optimized content. All changes to the UI need to be made via JavaScript.
[Remember](./start.md#architecture), Flarum's frontend is a **single-page JavaScript application**. There's no Twig, Blade, or any other kind of PHP template to speak of. The few templates that are present in the backend are only used to render search-engine-optimized content. All changes to the UI need to be made via JavaScript.

Flarum has two separate frontend applications:

Expand Down Expand Up @@ -222,7 +222,7 @@ Flarum will make anything you `export` from `forum.js` available in the global `

:::tip External Libraries

Only one main JavaScript file per extension is permitted. If you need to include any external JavaScript libraries, either install them with NPM and `import` them so they are compiled into your JavaScript file, or see [Routes and Content](/extend/routes.md) to learn how to add extra `<script>` tags to the frontend document.
Only one main JavaScript file per extension is permitted. If you need to include any external JavaScript libraries, either install them with NPM and `import` them so they are compiled into your JavaScript file, or see [Routes and Content](./routes.md) to learn how to add extra `<script>` tags to the frontend document.

:::

Expand Down
22 changes: 11 additions & 11 deletions docs/extend/update-2_0.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,24 +47,24 @@ flarum-cli upgrade 2.0
```
* Importing from `@flarum/core` no longer works. It was previously only allowed for the compat API.
* The `useExtensions` webpack option has been removed, use the import format explained above to import using the export registry instead.
* Some flarum modules are now lazy loaded, such as `LogInModal`. You have to make sure they have been loaded before using them, or you can trigger the loading yourself. See the [Code Splitting](/extend/code-splitting) documentation for more information.
* Some flarum modules are now lazy loaded, such as `LogInModal`. You have to make sure they have been loaded before using them, or you can trigger the loading yourself. See the [Code Splitting](./code-splitting) documentation for more information.

:::info

Read more about the export registry and how to use it in the [Export Registry](/extend/registry) documentation.
Read more about the export registry and how to use it in the [Export Registry](./registry) documentation.

:::

:::tip

Familiarize yourself with the new [Code Splitting](/extend/code-splitting) feature to lazy load modules and improve overall performance.
Familiarize yourself with the new [Code Splitting](./code-splitting) feature to lazy load modules and improve overall performance.

:::

### Admin Search

##### <span class="breaking">Breaking</span>
* `app.extensionData` has been renamed to `app.registry`, but you should now use the [`Admin` extender](/extend/admin.md) instead.
* `app.extensionData` has been renamed to `app.registry`, but you should now use the [`Admin` extender](./admin.md) instead.

##### <span class="notable">Notable</span>
* The admin dashboard now has a search feature, as long as you register your settings/permissions using the `Admin` extender, then they will be automatically picked up.
Expand Down Expand Up @@ -115,8 +115,8 @@ There have been many changes to the core frontend codebase, including renamed or
* A `Notices` component has been added that allows you to easily add global alerts above the hero.
* A `Footer` component has been added that allows you to easily add content to the footer.
* A `Form` component has been added to ensure consistent styling across forms. You should use this component in your extension if you are creating a form.
* An API for frontend gambits has been introduced, [checkout the full documentation](/extend/search#gambits).
* A `FormGroup` component has been added that allows you to add any supported type of input similar to the admin panel's settings registration. [checkout the documentation for more details](/extend/forms).
* An API for frontend gambits has been introduced, [checkout the full documentation](./search#gambits).
* A `FormGroup` component has been added that allows you to add any supported type of input similar to the admin panel's settings registration. [checkout the documentation for more details](./forms).

## Backend

Expand Down Expand Up @@ -195,7 +195,7 @@ Flarum 2.0 completely refactors the JSON:API implementation. The way resource CR
* The `Saving` are dispatched after the validation process instead of before.
* The various validators have been removed. This includes the `DiscussionValidator`, `PostValidator`, `TagValidator`, `SuspendValidator`, `GroupValidator`, `UserValidator`.
* Many command handlers have been removed. Use the `JsonApi` class if you wish to execute logic from an existing endpoint internally instead.
* The `flarum.forum.discussions.sortmap` singleton has been removed. Instead, you can define an `ascendingAlias` and `descendingAlias` [on your added `SortColumn` sorts](/extend/api#adding-sort-columns).
* The `flarum.forum.discussions.sortmap` singleton has been removed. Instead, you can define an `ascendingAlias` and `descendingAlias` [on your added `SortColumn` sorts](./api#adding-sort-columns).
* The `show` discussion endpoint no longer includes the `posts` relationship, so any `posts.*` relation includes or eager loads added to that endpoint must be removed.

Replacing the deleted classes is the new `AbstractResource` and `AbstractDatabaseResource` classes. We recommend looking at a comparison between the bundled extensions (like tags) from 1.x to 2.x to have a better understanding of the changes:
Expand All @@ -204,7 +204,7 @@ Replacing the deleted classes is the new `AbstractResource` and `AbstractDatabas

:::caution Refer to the documentation

Read about the full extent of the new introduced implementation and its usage in the [JSON:API](/extend/api) section.
Read about the full extent of the new introduced implementation and its usage in the [JSON:API](./api) section.

:::

Expand All @@ -218,12 +218,12 @@ The search system has been refactored to allow for more flexibility and extensib
##### <span class="breaking">Breaking</span>
* The old system decided between using the model filterer and the model searcher based on whether a search query `filter[q]` was provided. The new system does not have *filterers* anymore, but the distinction is still present, the only difference is that the default database search driver is always used when no search query is provided.
* If you have a class extending `AbstractFilterer` (a filterer) you should now extend `AbstractSearcher` instead (a searcher). If you already have a searcher for the same model, you can remove the filterer. Filters can be assigned to the searcher class.
* Gambits have been removed from the backend. There are only filters now per model searcher. The concept of gambits has been moved to the frontend instead. See the [search documentation gambits section](/extend/search#gambits) for more details.
* Gambits have been removed from the backend. There are only filters now per model searcher. The concept of gambits has been moved to the frontend instead. See the [search documentation gambits section](./search#gambits) for more details.
* Some namespaces have been changed or removed. The classes within `Flarum\Query` have been moved to `Flarum\Search`. The classes within `Flarum\Filter` have been moved to `Flarum\Search\Filter`. The `FilterState` class has been removed, you should use the `SearchState` class instead.
* The database search state now returns an Eloquent query builder instead of a database query builder.

##### <span class="notable">Notable</span>
* A new search driver API has been introduced. Checkout the [search documentation](/extend/search) for more details on how to use it.
* A new search driver API has been introduced. Checkout the [search documentation](./search) for more details on how to use it.
* You can now get the total search result count from `SearchResults`.
* You can now replace an existing filter implementation.

Expand All @@ -236,7 +236,7 @@ The search system has been refactored to allow for more flexibility and extensib

:::tip

Checkout the [database documentation](/extend/database) for more details.
Checkout the [database documentation](./database) for more details.

:::

Expand Down
4 changes: 2 additions & 2 deletions docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ We're still working on a formal roadmap. We have a lot of plans and ideas, and l

All donations are gratefully received. You can give on [GitHub Sponsors](https://github.com/sponsors/flarum) or [OpenCollective](https://opencollective.com/flarum).

However, donations will not directly impact the speed of development on Flarum. We also encourage users to contribute in other ways, such as [contributing code](contributing.md), [building extensions](/extend/README.md), writing documentation, translating Flarum into other languages, providing help and support on the [community forums](https://discuss.flarum.org/)... and just being a general positive energy around the community!
However, donations will not directly impact the speed of development on Flarum. We also encourage users to contribute in other ways, such as [contributing code](contributing.md), [building extensions](./extend/README.md), writing documentation, translating Flarum into other languages, providing help and support on the [community forums](https://discuss.flarum.org/)... and just being a general positive energy around the community!

### Will Flarum have [insert feature here]? When? Why not?

Expand All @@ -32,4 +32,4 @@ We don't currently provide official migrators, but there are many community solu
The real answer is that we generally keep an eye on our community for stand-out members who would make good staff. Honestly, for most of our current staff, what they did before becoming staff wasn't much different from what they do now.

Find a passion and contribute however you feel is best. Then let it take its course. You don't have to have a badge to be respected here.
Find a passion and contribute however you feel is best. Then let it take its course. You don't have to have a badge to be respected here.

0 comments on commit 4f2fb2e

Please sign in to comment.