Skip to content
This repository was archived by the owner on Jan 7, 2025. It is now read-only.

[EDX-218] Update README with an introduction and further information #23

Merged
merged 3 commits into from
Aug 17, 2022
Merged

[EDX-218] Update README with an introduction and further information #23

merged 3 commits into from
Aug 17, 2022

Conversation

m-hulbert
Copy link
Contributor

This PR adds the following to the README:

  • An introduction
  • Updated list of conventions
  • Description of table columns
  • Example text for API reference introductory text

@m-hulbert m-hulbert requested a review from tbedford August 16, 2022 17:12
@m-hulbert m-hulbert self-assigned this Aug 16, 2022
tbedford
tbedford suggested changes Aug 17, 2022
View reviewed changes
Copy link
Contributor

@tbedford tbedford left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, couple of minor points on formatting.

@m-hulbert m-hulbert requested a review from tbedford August 17, 2022 09:27
tbedford
tbedford approved these changes Aug 17, 2022
View reviewed changes
Copy link
Contributor

@tbedford tbedford left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor style point but otherwise looks good so approving.

@m-hulbert m-hulbert marked this pull request as ready for review August 17, 2022 10:53
@m-hulbert m-hulbert merged commit 6dbaf8c into main Aug 17, 2022
@m-hulbert m-hulbert deleted the edx-218-update-readme branch August 17, 2022 10:53
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@tbedford tbedford tbedford approved these changes

Assignees

@m-hulbert m-hulbert

Labels
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@m-hulbert @tbedford