microsoft / microsoft/api-guidelines

Turn into a GitHub Pages website

Open
#178 2 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
No language data
Stars
23.3k
Forks
2.7k
PR merge metrics
No merged PRs in 30d

Description

This is related to #105. If the guidelines were in README.md, turning on GitHub Pages is a matter of clicking one button and then the link could be included in the repository description row on GitHub. This would make it super easy to share the site in a form which is nice for reading.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with README.md and the related issue #105, then check the repository's GitHub Pages settings and the current repository description. Done means the guidelines are available as a readable GitHub Pages site and the published link is included in the repository description.

Written by the indexing model from the issue text.

Assessment

Tech stack
github
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.