Comments (11)
The motivation is to increase the number of passing-by contributions—or, at least, make them easier. This started as a conversation on Slack with David Storrs, Ben Greenman, Sam Tobin-Hochstadt and myself.
I want to vouch for Idea 3. But, as someone that doesn’t host their Racket packages on GitHub—I use my own Git server—I’d say we add @edit-link
instead of @github-link
. No reason to tie the feature to GitHub, I believe. Also, I think it’s more principled. It is always correct and doesn’t rely on magic. At the cost of adding a burden to documentation authors, it’s true.
from scribble.
Alternatively, another idea that Sam Tobin-Hochstadt gave: have a form like the one in http://beautifulracket.com/explainer/lang-line.html. What it would do is up to debate. Send emails to the mailing list, maybe? The content/noise ratio could be a problem.
from scribble.
Idea 1 (the dream) change Scribble to automatically add "edit on github" links to the drop-down that appears when you click headings (just below "link to this section"). Guess this would only work for cloned packages.
Could you clarify why this only works for cloned packages? I'm not understanding that point. Can't this be inferred from the package name-to-source-URL mapping? Or is that not available during document rendering?
I would prefer option 1 or 2 with option 3 as an override, in the event of a section that presents some strange corner case.
from scribble.
Could you clarify why this only works for cloned packages? I'm not understanding that point. Can't this be inferred from the package name-to-source-URL mapping? Or is that not available during document rendering?
Oops, I didn't realize there was a package-name-to-source-URL mapping. (I see pkg-catalog-show
can get the github url for packages like htdp, and (find-user-pkgs-dir)
returns a directory with URLs for user packages.) Seems like the URL should be available when building Scribble documents in raco setup
.
from scribble.
Some time ago on Racket Users I suggested a simple solution (last message in the thread):
Correcting documentation à la Beautiful Racket
The idea is to simply use a hyperlink that will prepopulate the new github issue form with a title, possibly a location of the text to correct, etc. It could be done similar to the current Beautiful Racket implementation - but by clicking flag icon on the margin of the text it will lead the user to the github prepopulated form, eg:
https://github.com/mbutterick/pollen/issues/new?title=foo&body=bar
from scribble.
Related: racket/racket#874
from scribble.
from scribble.
yes, I think that's a must for whatever we end up merging
EDIT: sam is right, I was thinking about source links (not editing) when I wrote this comment
from scribble.
I think enabling non-github editing in the browser would be a lot of extra work, and we should aim for that only after we have a solution that first just links to the source code.
from scribble.
I have started a proposal that is related to the discussion: #228
@soegaard: as to the github link - this would only work for registered github users.
from scribble.
is this still an issue? Please consider adding the label good first issue
so it is findable:
Issues labeled good first issue
in in Racket GitHub repositories
from scribble.
Related Issues (20)
- scribble-html does not support chinese HOT 2
- `proc-doc/names` shows unsupported procedure contract form but for valid syntax HOT 1
- recent versions of newtxmath define widebar, breaking scribble output HOT 9
- binary package does not include css
- Empty lines for grouping in `scribble/example` `@examples`
- Missing license information for LaTeX files HOT 2
- `scribble/text-render` doesn't respect `(linebreak)` HOT 3
- Should `output` and `outputable/c` also accept a generic interface?
- Feature request: Anchor links on hover
- The scribble documentation doesn't say how to install scribble HOT 10
- Small scribble doc w/`pict` & `/gui` seems to cause ObjC exception HOT 1
- ORCID in acmart generates invalid link HOT 1
- Autobib citation links jump to the wrong place in PDF backend
- Secref ignores #:link-render-style
- HTML style attributes aren't applied to `*section`s HOT 2
- Feature request: Wrap a `div` with a class around the HTML for a `part`
- Incorrect package computation HOT 8
- scribble/doclang and scribble/doclang2 should not be defmodulelang
- Contract violation when using prefab struct datums w/linebreaks in `racketblock`
- Cyrillic titles / sections / etc. generate incorrect links HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from scribble.