Skip to content

[MOB-17170] Documentation getting-started and api-reference#278

Merged
kevinlind merged 9 commits intoadobe:devfrom
kevinlind:mob-17170
Oct 7, 2022
Merged

[MOB-17170] Documentation getting-started and api-reference#278
kevinlind merged 9 commits intoadobe:devfrom
kevinlind:mob-17170

Conversation

@kevinlind
Copy link
Copy Markdown
Contributor

@kevinlind kevinlind commented Oct 5, 2022 •
edited
Loading

Description

Adds Documentation folder with api-reference.md and getting-started.md docs.
The majority of the documentation was taken from the public Git Book site. The API references for getLocationHint and setLocationHint are new.

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • I have signed the Adobe Open Source CLA.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@kevinlind kevinlind requested review from cacheung and emdobrin October 5, 2022 04:48
@codecov
Copy link
Copy Markdown

codecov bot commented Oct 5, 2022 •
edited
Loading

Codecov Report

Merging #278 (7cdc1e3) into dev (b640ce8) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##              dev     #278   +/-   ##
=======================================
  Coverage   95.50%   95.50%           
=======================================
  Files          28       28           
  Lines        1045     1045           
=======================================
  Hits          998      998           
  Misses         47       47

cacheung
cacheung reviewed Oct 5, 2022
View reviewed changes
emdobrin
emdobrin reviewed Oct 6, 2022
View reviewed changes
emdobrin
emdobrin reviewed Oct 6, 2022
View reviewed changes
Documentation/getting-started.md Outdated

```swift
dependencies: [
.package(url: "https://github.com/adobe/aepsdk-edge-ios.git", .upToNextMajor(from: "1.1.0"))
Copy link
Copy Markdown
Contributor

@emdobrin emdobrin Oct 6, 2022

Choose a reason for hiding this comment

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

we should include core and edgeidentity too

@kevinlind kevinlind merged commit 54d6a06 into adobe:dev Oct 7, 2022
@kevinlind kevinlind deleted the mob-17170 branch October 7, 2022 01:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@cacheung cacheung cacheung left review comments

@emdobrin emdobrin emdobrin approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@kevinlind @cacheung @emdobrin