UniversalMediaServer / UniversalMediaServer/UniversalMediaServer
Documentation project
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 2.7k
- Forks
- 528
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 23
Description
@UniversalMediaServer/developers @Atamariya Any thoughts on that ?
https://github.com/blog/2233-publish-your-project-documentation-with-github-pages
https://pages.github.com/
https://help.github.com/articles/configuring-a-publishing-source-for-github-pages/
https://help.github.com/articles/using-jekyll-as-a-static-site-generator-with-github-pages/
As already discussed, the different documentations, website, help, wiki, not uniformized, updated are a problem that we should try to avoid; this easy and efficient way could benefit to the developpement of this project and to the users as well.
Note: https://github.com/davisp/ghp-import
https://help.github.com/articles/creating-pages-with-the-automatic-generator/
P.S. And if you really love it to much you can make it your bible https://www.gitbook.com/blog/features/import-github 😆
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the linked GitHub Pages, publishing-source, Jekyll, ghp-import, and GitBook references, then inventory the project's website, help, wiki, and other documentation. Define the documentation scope and publishing approach; done means the project has a uniform, maintained documentation structure.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github, jekyll
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100