linebender / linebender/druid

Flex documentation and the book's use of flex are outdated

Open
#1,122 1 comment 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs
Dominant language
Rust
Stars
9.7k
Forks
565
PR merge metrics
No merged PRs in 30d

Description

I worked through the current behavior of flex, and had some issues getting what I needed from the docs, and the book is out of date (appears to predate adding alignment and spacing options.

I'll either try to flesh out this complaint or work the docs issue myself soon.

[Zulip thread for reference](https://xi.zulipchat.com/#narrow/stream/147922-new-members/topic/Second.20book.20example.20doesn't.20work/)

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 comparing the current flex documentation with the book's flex material, using the linked Zulip thread for the reported second-example problem. Update the documentation and book to cover the alignment and spacing options and bring the example in line with current behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.