Documentation before 1.0 Release

[Noah-Silvera]

Table of all available configuration options

• What they do
• What the defaults are
• Add a warning about using the taxable_order_hook The taxable_order hook should document a warning around skipping transactions #50

Nexuses

• The nexus sync button and when to use it.

Reporting

• Walkthrough - how do you setup reporting/go through backfill/confirm it works
• When does a transaction get reported
• When does a refund transaction get reported
• Note that reporting is turned off by default.
• Why order-level adjustments are unsupported
• Backfilling historical orders safely

Changelog

• Pull breaking changes out of changelog into release notes
• Refactor changelog to be more organized
• Bug fixes, breaking changes, new features, high level summary. Re: Solidus or other projects

Other

• Note that purchasing gift cards is not taxable, do not report them.

[Noah-Silvera]

Note: We should probably put this stuff in the wiki

Someone will have to refactor the Readme to move non-relevant documentation into the wiki

[benjaminwil]

Note: We should probably put this stuff in the wiki

For now, I've made a pull request, #210, to add the configuration settings to the README.

One thing I don't like about GitHub wikis is that there's no way to version them alongside the code. For developer configuration settings, at least, this makes me think the README, or some other committed document, is the best place to describe the settings.

For reporting interface usage and documentation–the wiki might be a more appropriate place.

[benjaminwil]

Added an item to the list in the original issue post: "Nexus sync button and when to use it."

[benjaminwil]

Just refactored the list and checked off things that are documented in the README and on the wiki already.

[benjaminwil]

Add a warning about using the taxable_order_hook

@Noah-Silvera I am not sure how to document this. From the original ticket it seems like you have an idea of how to.

[benjaminwil]

Note that purchasing gift cards is not taxable, do not report them.

@forkata @Noah-Silvera Is this in-scope? Solidus doesn't provide gift cards by default, so I think it would be up to each store and its development team to handle this their own way.

[forkata]

@benjaminwil I don't think GC's are in scope since like you said it's not a feature Solidus provides out of the box.