michael / michael/editable

Evolve AGENTS.md into an "Editable website development" skill

Open Beginner friendly
#181 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Svelte
Stars
1.8k
Forks
150
Avg merge
11h 46m
Merged PRs (30d)
8

Description

This should specify the do's and dont's of editable website development. Especially cover some rules that are important so you don't accidentally break editing. Also cover the WYSIWYG principle. That means content should look the same during editing and during viewing. Which means some patterns should be avoided. E.g. stacked cards, interactive content etc. You can still do that but then you need to come up with 2 different views. One for editing and one for viewing, and this will not feel as great as if editing and reading are exactle the same.

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 by reading AGENTS.md and identify how its current guidance is organized. Expand it into an editable website development skill covering editing safety, WYSIWYG behavior, and patterns such as stacked cards or interactive content. Done means the document clearly explains the do's and don'ts and distinguishes when separate editing and viewing layouts are needed.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, web-dev
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
72/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.