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

Remove README tables of contents #596

Merged
merged 2 commits into from
Oct 6, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .changeset/perfect-wasps-rush.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
"skuba": patch
---

template: Remove README tables of contents

GitHub's Markdown renderer now generates its own table of contents.
17 changes: 0 additions & 17 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,23 +17,6 @@ so don't commit or post anything that isn't ready for the entire world to see.

---

## Table of contents

- [Getting started](#getting-started)
- [I want to discuss or report something](#i-want-to-discuss-or-report-something)
- [I want to contribute a change](#i-want-to-contribute-a-change)
- [Development](#development)
- [Prerequisites](#prerequisites)
- [Git workflow](#git-workflow)
- [Testing](#testing)
- [Running locally](#running-locally)
- [Releases](#releases)
- [Creating a changeset](#creating-a-changeset)
- [Publishing a release](#publishing-a-release)
- [Publishing a prerelease](#publishing-a-prerelease)

---

## Getting started

**skuba** is documented through its [README](README.md),
Expand Down
8 changes: 0 additions & 8 deletions docs/deep-dives/babel.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,6 @@ This topic provides some context around this decision and discusses how Babel st

---

## Table of contents

- [Background](#background)
- [~~Try it out~~](#try-it-out)
- [~~Current limitations~~](#current-limitations)

---

## Background

> ["Using the TypeScript compiler is still the preferred way to build TypeScript."](https://devblogs.microsoft.com/typescript/typescript-and-babel-7/)
Expand Down
9 changes: 0 additions & 9 deletions docs/migration-guides/seek-module-toolkit.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,6 @@ parent: Migration guides

---

## Table of contents

- [TL;DR](#tldr)
- [Building](#building)
- [Formatting and linting](#formatting-and-linting)
- [Committing and releasing](#committing-and-releasing)

---

## TL;DR

```shell
Expand Down
12 changes: 0 additions & 12 deletions template/express-rest-api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,18 +23,6 @@ Next steps:
request installation in [SEEK-Jobs/renovate].
9. [ ] Delete this checklist 😌.

## Table of contents

- [Design](#design)
- [Development](#development)
- [Test](#test)
- [Lint](#lint)
- [Start](#start)
- [Deploy](#deploy)
- [Support](#support)
- [Dev](#dev)
- [Prod](#prod)

## Design

<%-repoName %> is a Node.js HTTP server built in line with our [technology strategy].
Expand Down
12 changes: 0 additions & 12 deletions template/greeter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,18 +21,6 @@ Next steps:
request installation in [SEEK-Jobs/renovate].
8. [ ] Delete this checklist 😌.

## Table of contents

- [Design](#design)
- [Development](#development)
- [Test](#test)
- [Lint](#lint)
- [Start](#start)
- [Deploy](#deploy)
- [Support](#support)
- [Dev](#dev)
- [Prod](#prod)

## Design

The `greeter` template is the prototypical _hello world_ project.
Expand Down
12 changes: 0 additions & 12 deletions template/koa-rest-api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,18 +23,6 @@ Next steps:
request installation in [SEEK-Jobs/renovate].
9. [ ] Delete this checklist 😌.

## Table of contents

- [Design](#design)
- [Development](#development)
- [Test](#test)
- [Lint](#lint)
- [Start](#start)
- [Deploy](#deploy)
- [Support](#support)
- [Dev](#dev)
- [Prod](#prod)

## Design

<%-repoName %> is a Node.js HTTP server built in line with our [technology strategy].
Expand Down
12 changes: 0 additions & 12 deletions template/lambda-sqs-worker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,18 +22,6 @@ Next steps:
request installation in [SEEK-Jobs/renovate].
9. [ ] Delete this checklist 😌.

## Table of contents

- [Design](#design)
- [Development](#development)
- [Test](#test)
- [Lint](#lint)
- [Start](#start)
- [Deploy](#deploy)
- [Support](#support)
- [Dev](#dev)
- [Prod](#prod)

## Design

<%-repoName %> is a Node.js [Lambda] application built in line with our [technology strategy].
Expand Down
14 changes: 0 additions & 14 deletions template/oss-npm-package/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,20 +18,6 @@ Next steps:
request installation in [#open-source].
7. [ ] Delete this checklist 😌.

## Table of contents

- [API](#api)
- [`log`](#log)
- [Development](#development)
- [Prerequisites](#prerequisites)
- [Test](#test)
- [Lint](#lint)
- [Package](#package)
- [Release](#release)
- [Commit messages](#commit-messages)
- [Releasing latest](#releasing-latest)
- [Releasing other dist-tags](#releasing-other-dist-tags)

## API

### `log`
Expand Down
14 changes: 0 additions & 14 deletions template/private-npm-package/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,20 +18,6 @@ Next steps:
request installation in [SEEK-Jobs/renovate].
7. [ ] Delete this checklist 😌.

## Table of contents

- [API](#api)
- [`log`](#log)
- [Development](#development)
- [Prerequisites](#prerequisites)
- [Test](#test)
- [Lint](#lint)
- [Package](#package)
- [Release](#release)
- [Commit messages](#commit-messages)
- [Releasing latest](#releasing-latest)
- [Releasing other dist-tags](#releasing-other-dist-tags)

## API

### `log`
Expand Down