Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation changes for all projects #8

Open
3 of 7 tasks
gep13 opened this issue Apr 14, 2017 · 8 comments
Open
3 of 7 tasks

Documentation changes for all projects #8

gep13 opened this issue Apr 14, 2017 · 8 comments

Comments

@gep13
Copy link
Member

gep13 commented Apr 14, 2017

  • Add Gitter and GitHub footer links to all sites
  • Add clipboard and anchor links to all sites
  • Correct spelling mistake of glady
  • Fix license URL's on readme
  • Adding contributing information to each site
  • Remove global namespace
  • Added title to all sites
@gep13
Copy link
Member Author

gep13 commented Apr 16, 2017

This has been completed on the following:

  • Cake.AliaSql
  • Cake.DocFx

@pascalberger
Copy link
Member

@gep13 IMHO contributing information is better placed in a CONTRIBUTING.md file in the repository root than as part of the Wyam generated documentation, since this would allow to have it integrated in the GitHub UI.

@gep13
Copy link
Member Author

gep13 commented Apr 18, 2017

Interesting.

This is what I originally had in mind?

https://cake-contrib.github.io/Cake.AliaSql/docs/contributing/how-to

Very basic, with a reference back to the main document (which I see now is actually a broken link).

I take the point about integrating with the GitHub UI though.

Perhaps the build process could copy the contributing.md into the input folder prior to generating the Wyam docs, that way it exists in both places?

@pascalberger
Copy link
Member

Yeah, saw that page :) Copying the CONTRIBUTING.md to the Wyam input during build might be a good solution.

@gep13
Copy link
Member Author

gep13 commented Apr 18, 2017

So that is a change to Cake.Recipe, which would work across all sites using Wyam then? Will mull that one over for a bit...

@pascalberger
Copy link
Member

A generic implementation in Cake.Recipe would be nice

@pascalberger
Copy link
Member

Also it would be nice if we could put as much as possible into a Wyam theme, recipe or module to simplify management and updates of all the different sites. It should be possible to do for eg anchoring, code block copying or footer buttons.

@gep13
Copy link
Member Author

gep13 commented Apr 20, 2017

@pascalberger that is an interesting idea. I will put my hand up and say that I haven't fully grokked how all the Wyam pieces fit together yet. I have it on my list to sit down and figure that out. I definitely like the idea of minimizing the amount of effort in applying changes across all the repositories.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants