Skip to content

Commit eaea0ca

Browse files
committed
Reformatting + links fixed.
1 parent a5dd536 commit eaea0ca

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+404
-313
lines changed

CONTRIBUTING.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,12 @@ If you discover a security vulnerability within Twill, please email us at [secur
1515

1616
Twill follows [Semantic Versioning](https://semver.org/). Major releases are released only when breaking changes are necessary, while minor and patch releases may be released as often as every week. Minor and patch releases should never contain breaking changes.
1717

18-
When referencing Twill from your application, you should always use a version constraint such as `^2.0`, since major releases of Twill do include breaking changes.
18+
When referencing Twill from your application, you should always use a version constraint such as `^3.0`, since major releases of Twill do include breaking changes.
1919

2020
# Which branch?
21-
All bug fixes should be sent to the latest stable branch (`2.x`). Bug fixes should never be sent to the `main` branch unless they fix features that exist only in the upcoming release.
21+
All bug fixes should be sent to the latest stable branch (`3.x`). Bug fixes should never be sent to the `main` branch unless they fix features that exist only in the upcoming release.
2222

23-
Minor features that are fully backwards compatible with the current Twill release may be sent to the latest stable branch (`2.x`).
23+
Minor features that are fully backwards compatible with the current Twill release may be sent to the latest stable branch (`3.x`).
2424

2525
Major new features should always be sent to the `main` branch, which contains the upcoming Twill release.
2626

docs/content/1_documentation/10_buckets/1_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Then, define your buckets configuration:
5050

5151
You can allow mixing modules in a single bucket by adding more modules to the `bucketables` array.
5252
Each `bucketable` should have
53-
its [model morph map](https://laravel.com/docs/5.5/eloquent-relationships#polymorphic-relations) defined because
53+
its [model morph map](https://laravel.com/docs/9.x/eloquent-relationships#polymorphic-relationships) defined because
5454
features are stored in a polymorphic table.
5555
In your AppServiceProvider, you can do it like the following:
5656

docs/content/1_documentation/11_settings-sections/2_legacy.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Settings sections are standalone forms that you can add to your Twill's navigati
1111
manage simple key/value records for you to then use anywhere in your application codebase.
1212

1313
Start by enabling the `settings` feature in your `config/twill.php` configuration file `enabled` array.
14-
See [Twill's configuration documentation](/enabled-features/) for more information.
14+
See [Twill's configuration documentation](../2_getting-started/3_configuration.md) for more information.
1515

1616
If you did not enable this feature before running the `twill:install` command, you need to copy the migration
1717
in `vendor/area17/twill/migrations/create_settings_table.php` to your own `database/migrations` directory and migrate

docs/content/1_documentation/13_user-management/1_index.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -141,9 +141,9 @@ You can use your new permission and existing ones in many places like the `twill
141141
```
142142

143143
Also in forms blade files using `@can`, as well as in middleware definitions in routes or controllers,
144-
see [Laravel's documentation](https://laravel.com/docs/5.7/authorization#via-middleware) for more info.
144+
see [Laravel's documentation](https://laravel.com/docs/9.x/authorization#via-middleware) for more info.
145145

146-
You should follow the Laravel documentation regarding [authorization](https://laravel.com/docs/5.3/authorization). It's
146+
You should follow the Laravel documentation regarding [authorization](https://laravel.com/docs/9.x/authorization). It's
147147
pretty good. Also if you would like to bring administration of roles and permissions to the admin
148148
application, [spatie/laravel-permission](https://github.com/spatie/laravel-permission) would probably be your best
149149
friend.
@@ -152,7 +152,7 @@ friend.
152152

153153
**DANGER**: don't use this feature in `production` as your CMS will be open for public.
154154

155-
Developers can configure Twill to do auto login using a pre-defined username and password and skip the login form.
155+
Developers can configure Twill to do auto login using a pre-defined username and password and skip the login form.
156156

157157
To enable it you have to:
158158

docs/content/1_documentation/15_packages/1_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@ Packages are composer installable.
1010

1111
In the following section we will explain how you can create your own package.
1212

13-
- [Creating a package](./creating-a-package.md)
13+
- [Creating a package](./1_creating-a-package.md)
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# API Documentation
22

3-
[Doctum](https://github.com/code-lts/doctum) generated API documentation of the framework is available [here](https://twill.io/docs/api/2.x) for `2.x` and previous versions.
3+
[Doctum](https://github.com/code-lts/doctum) generated API documentation of the framework is
4+
available [here](https://twill.io/docs/api/3.x) for `3.x` and previous versions.
45

6+
- [`3.x`](https://twill.io/docs/api/3.x)
57
- [`2.x`](https://twill.io/docs/api/2.x)
68
- [`main`](https://twill.io/docs/api/main)

docs/content/1_documentation/1_preface/3_architecture-concepts.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## CRUD modules
44

5-
A Twill [CRUD module](/crud-modules/) is a set of classes and configurations in your Laravel application that enable
5+
A Twill [CRUD module](../3_modules/) is a set of classes and configurations in your Laravel application that enable
66
your publishers to manage a certain type of content. The structure of a CRUD module is completely up to you.
77

88
Another way to think of a CRUD module is as a feature rich Laravel resource. In other words (and for the non-Laravel
@@ -19,7 +19,7 @@ migrations and Eloquent model conventions.
1919

2020
Twill's CRUD modules features are enabled using PHP traits you include in your Eloquent models and Twill repositories,
2121
as well as various configuration variables, and a bunch of conventions to follow. Further guidance is documented in
22-
the [CRUD modules](/crud-modules/) section.
22+
the [CRUD modules](../3_modules/) section.
2323

2424
A Twill module can be modified however you like – you can include countless types of content fields, and change the
2525
organization and structure according to the needs of the module and your product. Setup is simple: you just need to
@@ -57,7 +57,7 @@ show and make parent/child relationships manageable on a module's records.
5757

5858
Elements are modules or snippets of content that are added to an entity, page, or screen. Examples include the ability
5959
to manage footer text or create a global alert that can be turned on/off, etc. Twill offers developers the ability to
60-
quickly create [settings sections](/settings-sections/) to manage elements. A Twill module could also be configured to
60+
quickly create [settings sections](../11_settings-sections) to manage elements. A Twill module could also be configured to
6161
manage any sort of standalone element or content composition. There's nothing wrong with having a database table with a
6262
single record if that is what your product require, so you should feel free to create a Twill module to have a custom
6363
form for a single record. You can use a Laravel seeder or migration to initialize your admin console with those records.

docs/content/1_documentation/1_preface/5_contribution-guide.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -29,16 +29,16 @@ Twill follows [Semantic Versioning](https://semver.org/). Major releases are rel
2929
necessary, while minor and patch releases may be released as often as every week. Minor and patch releases should never
3030
contain breaking changes.
3131

32-
When referencing Twill from your application, you should always use a version constraint such as `^2.0`, since major
32+
When referencing Twill from your application, you should always use a version constraint such as `^3.0`, since major
3333
releases of Twill do include breaking changes.
3434

3535
## Which branch?
3636

37-
All bug fixes should be sent to the latest stable branch (`2.x`). Bug fixes should never be sent to the `main` branch
37+
All bug fixes should be sent to the latest stable branch (`3.x`). Bug fixes should never be sent to the `main` branch
3838
unless they fix features that exist only in the upcoming release.
3939

4040
Minor features that are fully backwards compatible with the current Twill release may be sent to the latest stable
41-
branch (`2.x`).
41+
branch (`3.x`).
4242

4343
Major new features should always be sent to the `main` branch, which contains the upcoming Twill release.
4444

@@ -49,6 +49,6 @@ before submitting.
4949

5050
## Coding style
5151

52-
-
53-
PHP: [PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md).
52+
- PHP: [PSR-12 Coding Standard with small changes](https://github.com/area17/twill/blob/3.x/phpcs.xml).
53+
5454
- Javascript: [Standard](https://standardjs.com/), [Vue ESLint Essentials](https://github.com/vuejs/eslint-plugin-vue).

docs/content/1_documentation/2_getting-started/1_index.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Environment requirements
44

5-
Twill `3.x` is compatible with Laravel versions `8.x` to `9.x`, running on PHP 8.0 and above. As a dependency to your
5+
Twill `3.x` is compatible with Laravel version `9.x`, running on PHP 8.0 and above. As a dependency to your
66
own application, Twill shares Laravel's
77
[server requirements](https://laravel.com/docs/9.x/deployment#server-requirements).
88

@@ -39,9 +39,9 @@ developed and tested against MySQL (`>=5.7`) and PostgreSQL(`>=9.3`).
3939

4040
| | Supported versions | Recommended version |
4141
|:-----------|:------------------:|:-------------------:|
42-
| PHP | >= 8.0 | 8.1 |
43-
| Laravel | >= 8.0 | 9.x |
44-
| npm | >= 5.7 | 6.13 |
45-
| MySQL | >= 5.7 | 5.7 |
46-
| PostgreSQL | >= 9.3 | 10 |
42+
| PHP | >= 8.0 | 8.1 |
43+
| Laravel | >= 9.0 | 9.x |
44+
| npm | >= 5.7 | 6.13 |
45+
| MySQL | >= 5.7 | 5.7 |
46+
| PostgreSQL | >= 9.3 | 10 |
4747

docs/content/1_documentation/2_getting-started/2_installation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ From there, you might want to configure Twill's media library's storage provider
138138
By default Twill uses local storage and local image rendering using [Glide](https://glide.thephpleague.com/), if you
139139
have more advanced image storage needs you can setup AWS as instructed below.
140140

141-
See the [media library's configuration documentation](/media-library/) for more information.
141+
See the [media library's configuration documentation](../6_media-library) for more information.
142142

143143
### AWS
144144

0 commit comments

Comments
 (0)