summaryrefslogtreecommitdiff
path: root/docs/dev/contribution_guide.rst
AgeCommit message (Collapse)Author
2025-05-12[doc] add chapter on the purpose of (git) commits (#4729)Markus Heiser
Chapter on the purpose of (git) commits The commits and their messages are elementary for the traceability of changes and are unfortunately still too often given too little attention. It therefore seems necessary to dedicate a chapter to this topic in the context of development. Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2025-04-17[fix] docs: changed "many" to "some" for clarity in contribution guide's ↵Tommaso Colella
privacy by design section
2025-04-17[fix] docs: typos and minor refinements in contribution_guide.rstTommaso Colella
2025-04-17[fix] docs: better phrasing for many sections of contribution_guide.rstTommaso Colella
2025-04-17[fix] docs: typos in dev contrib guide "it's might be becauseTommaso Colella
of the tool" -> "it might be because the tool"
2023-08-13[fix] typos in documentation & messagesToxyFlog1627
2023-08-06[doc] improve documentation of make targets and ./manage scriptMarkus Heiser
BTW force modularization of the ./mange script into sub modules: - utils/lib_sxng_data.sh - utils/lib_sxng_node.sh - utils/lib_sxng_static.sh - utils/lib_sxng_test.sh - utils/lib_sxng_themes.sh Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2023-07-01[doc] rearranges Settings & Engines docs for better readabilityMarkus Heiser
We have built up detailed documentation of the *settings* and the *engines* over the past few years. However, this documentation was still spread over various chapters and was difficult to navigate in its entirety. This patch rearranges the Settings & Engines documentation for better readability. To review new ordered docs:: make docs.clean docs.live Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-09-13[brand] docs - normalize project name to SearXNGMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2021-09-09[fix] remove references to transifexAlexandre Flament
2021-04-23[doc] modify docs to fit to the new build boilerplateMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-12-12[doc] update developer quickstart guideMarkus Heiser
See https://github.com/searx/searx/issues/2369#issuecomment-740652878 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-12-04[mod] documentations & comments: update http://* URL to https://*.Alexandre Flament
About http://lesscss.org see https://github.com/less/less-docs/issues/520
2020-10-30[mod] make docs-live - remove --port option from sphinx-autobuildMarkus Heiser
Setting port fixed to 8080 has drawbacks when this port is already in use from another application [1]. Removing this option from the command line offers the use of the sphinx-autobuild defaults which are much more flexible [2]. [1] https://github.com/searx/searx/issues/2282 [2] https://github.com/executablebooks/sphinx-autobuild/blob/master/README.md Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2020-09-28[fix] migration from github.com/asciimoo/searx to github.com/searx/searx : ↵Alexandre Flament
fix URLs
2020-02-04docs: revision of the installation instructionsMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-25docs(dev): add refs to to gitmoji and Semantic PR in contrib sectionMarkus Heiser
preview (don't bookmark): https://return42.github.io/searx/dev/contribution_guide.html#code Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-24doc(dev): add remarks about creating good commits (messages)Markus Heiser
preview (don't bookmark): https://return42.github.io/searx/dev/contribution_guide.html#code Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-22doc: add 'Architecture' article to admin sectionMarkus Heiser
Herein we add some hints and suggestions about typical architectures of searx infrastructures. We start with a contribution from @dalf - https://github.com/asciimoo/searx/pull/1776#issuecomment-567917320 thanks @dalf !! Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-18doc: describe Makefile targetsMarkus Heiser
With the aim to simplify development cycles, started with PR #1756 a Makefile based boilerplate was added. This patch adds the missing developer documentation. Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-13doc: add note about docs-clean targetMarkus Heiser
BTW: fix some typos Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-13doc: document the new reST & gh-pages workflowMarkus Heiser
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2019-12-12doc: proofread of the all reST sources (no content change)Markus Heiser
Normalize reST sources with best practice and KISS in mind. to name a few points: - simplify reST tables - make use of ``literal`` markup for monospace rendering - fix code-blocks for better rendering in HTML - normalize section header markup - limit all lines to a maximum of 79 characters - add option -H to the sudo command used in code blocks - drop useless indentation of lists - ... [1] https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2016-04-21add dev tips to quickstartNoemi Vanyi
2015-12-10[doc] rewrite contribution guideNoemi Vanyi
2015-11-17[enh] initial structureAdam Tauber
generated by cgit v1.2.3 (git 2.25.1) at 2026-03-03 18:36:13 +0000