rethinkdb / rethinkdb/docs

Make string manipulation functions easier to find

Open
#1,102 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
CSS
Stars
118
Forks
161
PR merge metrics
No merged PRs in 30d

Description

slice, and other functions work on many different types including strings, so they don't get put into the string manipulation section in the docs. I was looking for something like slice, but thought RethinkDB was missing it because it wasn't in the string manipulation section. I'm not sure what the answer is here. A few possibilities:

  • Leave it the same, people will learn that many RethinkDB functions work on multiple types
  • Create a way to view functions by the type they work on, rather than the category (sounds like a lot of work)
  • Write a guide on string manipulation with RethinkDB which collates all of the string functions together.

I think a guide could be a good option. To me string manipulation feels like a fundamentally different operation from operating on tables, sequences, or arrays, showing what options you have would be helpful.

OTOH, I think it's only slice, count, coerceTo that operate on strings and don't sit in the string manipulation section.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the documentation's string manipulation section and the existing entries for slice, count, and coerceTo. Compare how these functions are currently categorized, then determine whether a string-manipulation guide or another discoverability change fits the documentation structure. Done means the chosen approach is documented and all relevant string functions are easy to find.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.