diff --git a/docs/configuration/README.md b/docs/configuration/README.md index 0e1647c..5e2560a 100644 --- a/docs/configuration/README.md +++ b/docs/configuration/README.md @@ -132,7 +132,7 @@ Below is an example of what to do if you'd like navi to look like the French fla - The result: - ![img.png](/docs/src/configuration/navi-custom-colors.png) + ![navi-custom-colors](https://github.com/user-attachments/assets/d80352c5-d888-43e6-927d-805a8de1a7e2) ### Resizing columns diff --git a/docs/contributions/README.md b/docs/contributions/README.md index 1dbf420..6d14d7e 100644 --- a/docs/contributions/README.md +++ b/docs/contributions/README.md @@ -1,7 +1,16 @@ -# How to contribute to Navi +# Navi contributors This section is about the ways you can contribute to Navi and its ecosystem. + +* [Navi contributors](#navi-contributors) + * [How to contribute to Navi](#how-to-contribute-to-navi) + * [Versioning Scheme](#versioning-scheme) + * [Deprecation of features](#deprecation-of-features) + + +## How to contribute to Navi + You have multiple ways to contribute to navi, here are the documented ones: - [Write code for Navi](code/README.md) @@ -9,3 +18,30 @@ You have multiple ways to contribute to navi, here are the documented ones: - [Open Bug tickets](bugs/README.md) Please see each section for more details. + + +## Versioning Scheme + +| Type | Description | +|-------|--------------------------------------------------------------------------------------------------| +| Major | Anything which introduces a major breaking change. The bash to rust rewrite was such an example. | +| Minor | Almost everything. | +| Fix | A fix, just like its name. It should be micro releases with minimal changes. | + +## Deprecation of features + +Once you introduce a feature, you need to have a clear view of when we're +going to remove its support within navi. + +In order to offer stability to the users, we prefer having 10 minor versions +between the deprecation notice and the removal of its support. + +````txt +Version where the feature is being deprecated: 0.10.0 +Version where the support is dropped: 0.20.0 +```` + +> [!NOTE] +> This rule is not absolute and each feature deprecation needs to be handled +> carefully given its own circumstances, but try to stick as close as possible +> to this rule. diff --git a/docs/developers/README.md b/docs/developers/README.md deleted file mode 100644 index 92de8e9..0000000 --- a/docs/developers/README.md +++ /dev/null @@ -1,30 +0,0 @@ -# Developers documentation - -This documentation entry is destined to contributors of the navi project -and open-source repository. - -## Versioning Scheme - -| Type | Description | -|-------|--------------------------------------------------------------------------------------------------| -| Major | Anything which introduces a major breaking change. The bash to rust rewrite was such an example. | -| Minor | Almost everything. | -| Fix | A fix, just like its name. It should be micro releases with minimal changes. | - -## Deprecation of features - -Once you introduce a feature, you need to have a clear view of when we're -going to remove its support within navi. - -In order to offer stability to the users, we prefer having 10 minor versions -between the deprecation notice and the removal of its support. - -````txt -Version where the feature is being deprecated: 0.10.0 -Version where the support is dropped: 0.20.0 -```` - -> [!NOTE] -> This rule is not absolute and each feature deprecation needs to be handled -> carefully given its own circumstances, but try to stick as close as possible -> to this rule. diff --git a/docs/src/configuration/navi-custom-colors.png b/docs/src/configuration/navi-custom-colors.png deleted file mode 100644 index 2b3831b..0000000 Binary files a/docs/src/configuration/navi-custom-colors.png and /dev/null differ