swift-book
swift-book copied to clipboard
apple
Add a "Make a contribution" banner on footer or header
Description
To facilitate contributions, I recommend adding a "Make a contribution" banner or button to the header or footer of each page. This will allow users to easily submit pull requests if they notice any errors on that particular page. Clicking the banner/button will take them directly to the source file for that page with edit mode enabled.
For instance, if a user clicks on the "Make a contribution" banner while viewing the-swift-programming-language/aboutswift, they will be redirected to https://github.com/apple/swift-book/edit/main/TSPL.docc/GuidedTour/AboutSwift.md.
Motivation
Github's Open Source Doc Workflow
https://docs.github.com/
@nakul1710 Please feel free to make a pull request against DocC to add support for this behavior, and then open a pull request against TSPL to adopt the new behavior. You don't need to wait for someone else to assign the issue to you.
If your approach is complex, you can pitch it on the forums to get feedback about potential issues before you invest a lot of time programming.
Please feel free to make a pull request against DocC to add support for this behavior, and then open a pull request against TSPL to adopt the new behavior. You don't need to wait for someone else to assign the issue to you.
If your approach is complex, you can pitch it on the forums to get feedback about potential issues before you invest a lot of time programming.
Sorry, I do not have the permission to make an assign in this repo.
You can follow amartini51's suggestion to try it directly.
@Kyle-Ye can you assign this to me
I do not have the permission to make an assign in this repo. Maybe you should ask amartini51.
@nakul1710 Please see my comments from May 19 above. I suggest you make a PR with your suggested changes in the Swift-DocC repository, and in this repository.