Further-doc-improvements #20

Merged

ddevault merged 6 commits from further-doc-improvements into main

2024-04-03 10:07:00 +02:00

moonglum commented

2024-04-02 22:29:21 +02:00

Owner

Adjust links to the RESP spec
Move the pages discussed in #18 to docs/usage/clients
Adjust the links accordingly

linkchecker returns only two errors (without checking external URLs) on this branch:

URL        `/topics/cluster-spec'
Name       `Redict Cluster specification'
Parent URL http://localhost:1313/docs/usage/scaling/, line 1894, col 140
Real URL   http://localhost:1313/topics/cluster-spec
Check time 2.972 seconds
Result     Error: 404 Not Found

URL        `/docs/reference/cluster-spec/#hash-tags'
Name       `Hash tags'
Parent URL http://localhost:1313/docs/commands/keys/, line 1923, col 35
Real URL   http://localhost:1313/docs/reference/cluster-spec/#hash-tags
Check time 3.842 seconds
Result     Error: 404 Not Found

cluster-spec will move to the wiki, we need to adjust the link afterwards. This is out of scope for this PR.

* [x] Adjust links to the RESP spec * [x] Move the pages discussed in #18 to docs/usage/clients * [x] Adjust the links accordingly [linkchecker](https://linkchecker.github.io/linkchecker/) returns only two errors (without checking external URLs) on this branch: ``` URL `/topics/cluster-spec' Name `Redict Cluster specification' Parent URL http://localhost:1313/docs/usage/scaling/, line 1894, col 140 Real URL http://localhost:1313/topics/cluster-spec Check time 2.972 seconds Result Error: 404 Not Found URL `/docs/reference/cluster-spec/#hash-tags' Name `Hash tags' Parent URL http://localhost:1313/docs/commands/keys/, line 1923, col 35 Real URL http://localhost:1313/docs/reference/cluster-spec/#hash-tags Check time 3.842 seconds Result Error: 404 Not Found ``` cluster-spec will move to the wiki, we need to adjust the link afterwards. This is out of scope for this PR.

moonglum added 2 commits

2024-04-02 22:29:21 +02:00

Adjust links to RESP spec b5d7943a2d

Introduce the usage/clients section 2964676f3c

moonglum added 4 commits

2024-04-02 22:57:51 +02:00

Adjust links e7cc7a809e

Squashed 'data/redict_doc/' changes from 8d7a29ab..21753635 7bf88db49f

21753635 Adjust links
38fbb704 Adjust links
4f195f76 Remove files moved to redict/redict.io
1d885c79 Remove arm and protocol-spec

git-subtree-dir: data/redict_doc
git-subtree-split: 21753635e3a8ca1841e06da176ec04b1d0c028be

Merge commit '7bf88db49f' into further-doc-improvements 1abeec36a0

Add headings to the client pages 503aca422c