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

Psg 4901 use repo templates #13

Merged
merged 4 commits into from
Oct 24, 2024
Merged

Conversation

jenn-macfarlane
Copy link
Contributor

@jenn-macfarlane jenn-macfarlane commented Oct 22, 2024

What's New?

Uses repo templates to format README, LICENSE, and remove community files in favour of using organization community files.

Note

This repo contains documentation we do not yet have in our docs platform - I've integrated it as best I could to keep it somewhat in line with the template and preserving details.

Screenshots (if appropriate):

CleanShot 2024-10-22 at 15 42 00@2x

CleanShot 2024-10-22 at 15 42 09@2x

Type of change

  • 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 not work as expected)
  • Documentation update

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have manually tested my code thoroughly
  • I have added/updated inline documentation for public facing interfaces if relevant
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing integration and unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Additional context

Add any other context or screenshots about the pull request here.

README.md Outdated

Add an Android and/or iOS app in the Native Apps section.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think it makes sense to pull up these more detailed prereq steps into this section. We can delete them/edit what we have in the actual html template when we remove after we have this enshrined in docs.

README.md Outdated

See our [Passkey Complete documentation](https://docs.passage.id/complete/cross-platform-passkey-configuration/cross-platform-ios-configuration) for setting up a React Native app for passkeys and Passage.

#### Hosted associated domains files
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This felt right to put in this section as well

README.md Outdated
```

### Go Passwordless

Find all more details about Passkey Flex on our [Passkey Flex Documentation](https://docs.passage.id/flex) page.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Because we don't have docs, figured I'd link to the Flex docs homepage.


Find all more details about Passkey Flex on our [Passkey Flex Documentation](https://docs.passage.id/flex) page.

# API Reference
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Follows what we do in passage-react in the web monorepo

@agebhardt
Copy link
Contributor

I really like the approach here! I also added a suggestion via commit, @jenn-macfarlane! Open to your thoughts, but my goal was to simplify the initial view of the README a bit more 😄

@jenn-macfarlane
Copy link
Contributor Author

@agebhardt looks good to me!

@jenn-macfarlane jenn-macfarlane merged commit b1f78d6 into main Oct 24, 2024
4 checks passed
@jenn-macfarlane jenn-macfarlane deleted the PSG-4901-use-repo-templates branch October 24, 2024 17:10
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.

2 participants