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

Replace README Developer Information section with Table of contents #357

Merged
merged 1 commit into from
Nov 7, 2023

Conversation

adrianclay
Copy link
Collaborator

What

Replace README Developer Information section with Table of contents

Why

The existing Developer Information felt like some links out to other documents.

Having a clear table of contents feels like a clearer way of achieving the same outcome.

Type of change

Please delete options that are not relevant.

  • Internal change (non-breaking change with no effect on the functionality affecting end users)

Checklist:

  • I have performed a self-review of my code
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I have updated the Changelog with details of my change in the UNRELEASED section if this change will affect end users
  • A corresponding change has been made to the Mapping Documentation repository

@adrianclay adrianclay enabled auto-merge (squash) November 2, 2023 13:58
@adrianclay adrianclay force-pushed the create-table-of-contents branch 3 times, most recently from c79896a to 77e2455 Compare November 6, 2023 17:28
The existing Developer Information felt like some links out to other
documents.

Having a clear table of contents feels like a clearer way of achieving
the same outcome.
@adrianclay adrianclay force-pushed the create-table-of-contents branch from 77e2455 to 1e5ee50 Compare November 7, 2023 09:33
README.md Show resolved Hide resolved
@adrianclay adrianclay merged commit 66eac35 into main Nov 7, 2023
@adrianclay adrianclay deleted the create-table-of-contents branch November 7, 2023 10:25
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

Successfully merging this pull request may close these issues.

3 participants