Skip to content

docs: readme overhaul#116

Merged
rs-amp merged 8 commits into
amplience:masterfrom
mdinning-amp:docs/new-readme
Jan 6, 2022
Merged

docs: readme overhaul#116
rs-amp merged 8 commits into
amplience:masterfrom
mdinning-amp:docs/new-readme

Conversation

@mdinning-amp
Copy link
Copy Markdown
Contributor

@mdinning-amp mdinning-amp commented Nov 11, 2021

This PR includes updates to the project's readme file, and introduces a number of supporting docs files covering each command's usage.

Includes documentation for new commands introduced in pending PRs #105 & #111.

Comment thread README.md Outdated
Comment thread docs/CONTENT-ITEM.md Outdated
Comment thread docs/CONTENT-ITEM.md Outdated
Comment thread docs/CONTENT-ITEM.md Outdated
Comment thread docs/CONTENT-ITEM.md Outdated
Comment thread docs/EVENT.md Outdated
Comment thread docs/EXTENSION.md Outdated
Comment thread docs/HUB.md Outdated
Comment thread docs/SEARCH-INDEX.md Outdated
Comment thread docs/SETTINGS.md Outdated
@mdinning-amp mdinning-amp requested a review from rs-amp November 26, 2021 10:30
Copy link
Copy Markdown
Contributor

@rs-amp rs-amp left a comment

Choose a reason for hiding this comment

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

Looking good, just a few more comments.

It's worth noting that the events, dst options in the configuration file and content item facet stuff obviously depend on those PRs.

Comment thread README.md Outdated
Comment thread docs/CONTENT-ITEM.md Outdated
Comment thread docs/CONTENT-ITEM.md Outdated
Comment thread docs/EVENT.md Outdated
Comment thread docs/EVENT.md Outdated
Comment thread docs/HUB.md Outdated
Comment thread docs/HUB.md Outdated
Copy link
Copy Markdown
Contributor

@rs-amp rs-amp left a comment

Choose a reason for hiding this comment

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

LGTM - nice work!

@rs-amp rs-amp merged commit 49687d6 into amplience:master Jan 6, 2022
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.

4 participants