10 Commits

Author SHA1 Message Date
Jan Sandbrink 10cc0cc936 Consistently use the term "endpoint"
TIL that both "end point" and "endpoint" are valid,
but one source on the internet tells me that "endpoint"
is more commonly used and (more importantly) our code base
agrees. A case-sensitive search for "endpoint" gives me over
2000 results, over 300 of these are inside "docs/".
2025-10-17 13:21:50 +02:00
as-op 0e214970b4 fix header levels 2024-04-29 17:06:08 +02:00
as-op bba9cd268a add image descriptions; fix header level; harmonize with linting 2024-04-29 15:12:37 +02:00
as-op 9e72155b66 fix markdown quirks; harmonize; lint fixes 2024-04-29 13:52:04 +02:00
as-op 192d32dcdf docs(links): adjust relative paths 2023-12-12 12:23:46 +01:00
Oliver Günther 53ee07c84b Rewrite all docs.openproject.org links 2022-05-02 09:29:29 +02:00
Andrej Sandorf 887dbfe7b0 Docs cherry picks from release-12.0 (#10527)
* Chore/doc pngs (#10422)

* feat(docs): remove uppercase duplicate pngs

* feat(docs): reduce png file sizes

* Make the menu item for dev FAQ conistent

* Remove section

it does not add any value

* Initial draft

* Make the capitalization consistent for Release notes

* Make the menu entry for installation & operations guide consistent with heading

* Make the capitalization consistent for Enterprise guide

* Make capitalization consistent for System admin guide

* Make the capitalization consistent for API documentation

* Added missing elements, udpated status for each

Added links to some components and patterns that were missing and updated the status to accurately reflect the documentation status for each. No doc status for foundation library yet (some elements like Illustrations and Spacing don't need documentation, the rest is in progress)

* Example for implementation of Action bar

* Fixed markdown table, added implementation examples

* Adding link to Calendar module as example for an implemented component

* Added some examples, but they're mostly Include projects

* Correct capitalization of User guid in docs

Co-authored-by: Niels Lindenthal <lindenthal@users.noreply.github.com>
Co-authored-by: Parimal Satyal <88370597+psatyal@users.noreply.github.com>
2022-04-21 09:21:46 +02:00
Andrej Sandorf 638ef7b368 Fix/docs (#9442)
* fix(editorconfig): there's markdown in api yml - don't trim trailing whitespace

* fix(markdown): adjust markdown for kramdown parser

* fix(api-doc): adjust description markdowns, unify descriptions
2021-07-12 16:18:56 +02:00
Andrej Sandorf f4fb76209a Fix/docs-markdown [skip ci] (#9436)
* fix(docs): no hot-linking

* fix(docs): escape < and > in normal text
2021-07-06 16:36:00 +02:00
Oliver Günther e35f0cd8c8 Move BCF api into separate folder 2020-04-22 08:47:14 +02:00