Unibeautify / Unibeautify/website

Redo options table and list to make clear deprecated options

Open
#55 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement good first issue help wanted
Dominant language
TypeScript
Stars
10
Forks
28
Avg merge
1d 10h
Merged PRs (30d)
3

Description

https://unibeautify.com/docs/options.html and the contents of the left nav https://unibeautify.com/docs/option-align-assignments.html should make clear which options are deprecated.

Table

  1. Remove the option entirely from the table
  2. Add new column(s) to the table for newer metadata
  3. Leave table as-is

Nav

  1. Create a section beneath the "W" on the left named "Deprecated" and list options that are deprecated there instead of under their letter

Contributor guide

No contributing guide indexed for this repository

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 with the options table at https://unibeautify.com/docs/options.html and the left navigation at https://unibeautify.com/docs/option-align-assignments.html. Identify how options and metadata are generated, then update the table treatment and place deprecated options in a Deprecated section beneath W. Done means deprecated options are clearly separated in both views.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 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.