Skip to content
This repository has been archived by the owner on Jul 12, 2018. It is now read-only.

Commit

Permalink
addressing broken links
Browse files Browse the repository at this point in the history
#28 highlights 3 broken links on this page.  The problem is that there are not clear replacements for those links since the READMEs they point to have changed over time.  

This PR proposed pointing to a set of examples from analytics.usa.gov as a replacement.
  • Loading branch information
gbinal committed Nov 3, 2016
1 parent 2d74ee2 commit 8340c69
Showing 1 changed file with 1 addition and 3 deletions.
4 changes: 1 addition & 3 deletions pages/making-readmes-readable.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,7 @@ This should answer the question: **How do I get this project to work on my machi

Important: If relevant code changes, it’s important to test to ensure these instructions continue to work. We also recommend separating the sections for using a project versus developing for it. (More detailed instructions are located [in our guidelines](https://pages.18f.gov/open-source-program/pages/maintainer_guidelines/#usage-documentation) for writing documentation for users, contributors, and developers.)

**Example:** The README for 18F’s homepage contains detailed instructions for [developing the site](https://github.com/18F/18f.gsa.gov#developing-the-site) and [deploying the site](https://github.com/18F/18f.gsa.gov#deploying-the-site).

**Example:** The README for Midas contains a link to [installation instructions](https://github.com/18F/midas/blob/devel/INSTALL.md) for developers.
**Example:** The README for analytics.usa.gov contains detailed instructions for [developing the site](https://github.com/18f/analytics.usa.gov#setup) and [deploying the site](https://github.com/18f/analytics.usa.gov#deploying-to-staging-18f-specific).

## Instructions for how people can help.

Expand Down

0 comments on commit 8340c69

Please sign in to comment.