Skip to content

Make the README more clear and concise #5482

Open
fern-api[bot] wants to merge 1 commit into
mainfrom
fern/improve-readme
Open

Make the README more clear and concise #5482
fern-api[bot] wants to merge 1 commit into
mainfrom
fern/improve-readme

Conversation

@fern-api
Copy link
Copy Markdown
Contributor

@fern-api fern-api Bot commented May 12, 2026

Summary

Tightens the repository README so contributors can get oriented and running faster, without losing any of the existing guidance.

Changes

  • Intro: Replaces the welcome blurb with a one-line description of what this repo is.
  • Quickstart: Collapses the nested Prerequisites / Installation / Editing subsections into a single linear flow with one combined shell block. Same commands, fewer headings to scan.
  • Writing tips: Trims wordy bullets to their actionable core and removes the Orwell pull-quote so the section reads as a checklist of dos and don'ts.
  • Vale section: Reformats the enforced-style list for skimmability; merges duplicate phrasing (e.g., capitalized terminology bullets).
  • Getting changes reviewed: Keeps the same routing (issue for new pages / large changes, PR for everything else) in a shorter form.

No content was removed; everything that used to be in the README is still there, just shorter.

Notes

  • Net change: ~76 lines removed, ~38 lines added.
  • No links, commands, or workflow steps were changed.

Requested by: Fern Support

@fern-api fern-api Bot requested a review from devalog as a code owner May 12, 2026 20:15
@fern-api
Copy link
Copy Markdown
Contributor Author

fern-api Bot commented May 12, 2026

Requested by: paarth
Slack thread: View conversation

@github-actions
Copy link
Copy Markdown
Contributor

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants