hasura / hasura/graphql-engine
docs: add in-place doc editing
- Dominant language
- TypeScript
- Stars
- 32.1k
- Forks
- 3k
- PR merge metrics
- PR metrics pending
Description
We've been working with the Egghead folks on an in-page editor (not quite WYSIWYG, just real-time feedback) for their transcripts, which are backed by files on GitHub - very similar to Hasura docs! Submitting an edit to a doc requires a user to first authenticate with GitHub, then opens up a PR to the underlying project (graphql-engine) transparently.
Would it be useful to have something similar, so both editing docs and reviewing PRs could happen in-page? It's still a proof-of-concept, but it's already pretty solid and we're getting ready to polish it up.
For Hasura's doc, we'd have to change things around to use RST and whatnot, but I'm asking about the general idea.
[](https://youtu.be/2ztl_g39CkU? "Egghead in-page editing")
Contributor guide
Research direction
The issue names no repository files, tests, or entry points. Start by reviewing the linked Egghead proof of concept and the stated RST-based documentation change; define the scope for authenticated in-page editing, transparent PR creation, and in-page review before implementation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100