Skip to content

Use prose.io for friendlier github editing #192

@patcon

Description

@patcon

Hi again!

I see that you currently link each page in https://doc.highfidelity.com to the github page in the grav content repo. This is awesome!

Having said that, I wonder whether prose.io might better serve you. It's an alternative to the github edit interface, designed by a well-respected web dev agency called "Development Seed". This company wanted to a build on GitHub Pages, but didn't want to force non-technical users to wade through coder lingo. Its a little less value-add these days, as github has done a whole lot to improve the PR creation workflow, but it's still nice.

Prose.io is technically a really thin GitHub Pages app itself, totally open source -- it just uses a really slim authentication proxy to coordinate the oauth dance with github, but is otherwise stateless and just runs off github api. And fwiw, "Development Seed" are the creators of "MapBox", and they're a stable force imho.

So instead of linking to GitHub's edit page, you'd just link here:
http://prose.io/#highfidelity/hifi-docs-grav-content/blob/master/01.get-started/01.what-is-high-fidelity/docs.md

or here maybe:
http://prose.io/#highfidelity/hifi-docs-grav-content/edit/master/01.get-started/01.what-is-high-fidelity/docs.md

This is how it looks when submitting (ie. absolutely no github once you login):
https://imgur.com/dVw9jfX

And here's the generated PR:
#191

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions