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.

Sign up for GitHub

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

docs: add instructions #31

Merged
merged 3 commits into from
Jul 17, 2024
Merged

docs: add instructions #31

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
96cac0d
docs: adds guides, server and clients
PhearZero Jul 8, 2024
81ba750
docs: completes android and browser guides
PhearZero Jul 11, 2024
e4ec2b1
docs: update base path and sit url
PhearZero Jul 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/.astro/settings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"_variables": {
"lastUpdateCheck": 1720022313585
"lastUpdateCheck": 1721221209150
}
}
182 changes: 161 additions & 21 deletions docs/.astro/types.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,23 +136,163 @@ declare module 'astro:content' {

type ContentEntryMap = {
"docs": {
"guides/deep-dive.md": {
id: "guides/deep-dive.md";
slug: "guides/deep-dive";
"architecture.md": {
id: "architecture.md";
slug: "architecture";
body: string;
collection: "docs";
data: InferEntrySchema<"docs">
} & { render(): Render[".md"] };
"guides/getting-started.md": {
id: "guides/getting-started.md";
slug: "guides/getting-started";
"clients/android/answer.mdx": {
id: "clients/android/answer.mdx";
slug: "clients/android/answer";
body: string;
collection: "docs";
data: InferEntrySchema<"docs">
} & { render(): Render[".mdx"] };
"clients/android/authentication.mdx": {
id: "clients/android/authentication.mdx";
slug: "clients/android/authentication";
body: string;
collection: "docs";
data: InferEntrySchema<"docs">
} & { render(): Render[".mdx"] };
"clients/android/introduction.mdx": {
id: "clients/android/introduction.mdx";
slug: "clients/android/introduction";
body: string;
collection: "docs";
data: InferEntrySchema<"docs">
} & { render(): Render[".mdx"] };
"clients/android/offer.mdx": {
id: "clients/android/offer.mdx";
slug: "clients/android/offer";
body: string;
collection: "docs";
data: InferEntrySchema<"docs">
} & { render(): Render[".mdx"] };
"clients/android/provider-service/create-passkey.md": {
id: "clients/android/provider-service/create-passkey.md";
slug: "clients/android/provider-service/create-passkey";
body: string;
collection: "docs";
data: InferEntrySchema<"docs">
} & { render(): Render[".md"] };
"clients/android/provider-service/get-passkey.md": {
id: "clients/android/provider-service/get-passkey.md";
slug: "clients/android/provider-service/get-passkey";
body: string;
collection: "docs";
data: InferEntrySchema<"docs">
} & { render(): Render[".md"] };
"clients/android/provider-service/introduction.mdx": {
id: "clients/android/provider-service/introduction.mdx";
slug: "clients/android/provider-service/introduction";
body: string;
collection: "docs";
data: InferEntrySchema<"docs">
} & { render(): Render[".mdx"] };
"clients/android/registration.mdx": {
id: "clients/android/registration.mdx";
slug: "clients/android/registration";
body: string;
collection: "docs";
data: InferEntrySchema<"docs">
} & { render(): Render[".mdx"] };
"clients/browser/answer.mdx": {
id: "clients/browser/answer.mdx";
slug: "clients/browser/answer";
body: string;
collection: "docs";
data: InferEntrySchema<"docs">
} & { render(): Render[".mdx"] };
"clients/browser/authentication.md": {
id: "clients/browser/authentication.md";
slug: "clients/browser/authentication";
body: string;
collection: "docs";
data: InferEntrySchema<"docs">
} & { render(): Render[".md"] };
"clients/browser/example.md": {
id: "clients/browser/example.md";
slug: "clients/browser/example";
body: string;
collection: "docs";
data: InferEntrySchema<"docs">
} & { render(): Render[".md"] };
"guides/registration.md": {
id: "guides/registration.md";
slug: "guides/registration";
"clients/browser/introduction.mdx": {
id: "clients/browser/introduction.mdx";
slug: "clients/browser/introduction";
body: string;
collection: "docs";
data: InferEntrySchema<"docs">
} & { render(): Render[".mdx"] };
"clients/browser/offer.mdx": {
id: "clients/browser/offer.mdx";
slug: "clients/browser/offer";
body: string;
collection: "docs";
data: InferEntrySchema<"docs">
} & { render(): Render[".mdx"] };
"clients/browser/registration.mdx": {
id: "clients/browser/registration.mdx";
slug: "clients/browser/registration";
body: string;
collection: "docs";
data: InferEntrySchema<"docs">
} & { render(): Render[".mdx"] };
"guides/Passkey/authentication.mdx": {
id: "guides/Passkey/authentication.mdx";
slug: "guides/passkey/authentication";
body: string;
collection: "docs";
data: InferEntrySchema<"docs">
} & { render(): Render[".mdx"] };
"guides/Passkey/registration.mdx": {
id: "guides/Passkey/registration.mdx";
slug: "guides/passkey/registration";
body: string;
collection: "docs";
data: InferEntrySchema<"docs">
} & { render(): Render[".mdx"] };
"guides/Peer to Peer/answer.mdx": {
id: "guides/Peer to Peer/answer.mdx";
slug: "guides/peer-to-peer/answer";
body: string;
collection: "docs";
data: InferEntrySchema<"docs">
} & { render(): Render[".mdx"] };
"guides/Peer to Peer/offer.mdx": {
id: "guides/Peer to Peer/offer.mdx";
slug: "guides/peer-to-peer/offer";
body: string;
collection: "docs";
data: InferEntrySchema<"docs">
} & { render(): Render[".mdx"] };
"guides/components.mdx": {
id: "guides/components.mdx";
slug: "guides/components";
body: string;
collection: "docs";
data: InferEntrySchema<"docs">
} & { render(): Render[".mdx"] };
"guides/concepts.md": {
id: "guides/concepts.md";
slug: "guides/concepts";
body: string;
collection: "docs";
data: InferEntrySchema<"docs">
} & { render(): Render[".md"] };
"guides/getting-started.mdx": {
id: "guides/getting-started.mdx";
slug: "guides/getting-started";
body: string;
collection: "docs";
data: InferEntrySchema<"docs">
} & { render(): Render[".mdx"] };
"guides/qr-code.md": {
id: "guides/qr-code.md";
slug: "guides/qr-code";
body: string;
collection: "docs";
data: InferEntrySchema<"docs">
Expand All @@ -164,30 +304,30 @@ declare module 'astro:content' {
collection: "docs";
data: InferEntrySchema<"docs">
} & { render(): Render[".md"] };
"reference/typescript/auth/README.md": {
id: "reference/typescript/auth/README.md";
slug: "reference/typescript/auth/readme";
"server/environment-variables.md": {
id: "server/environment-variables.md";
slug: "server/environment-variables";
body: string;
collection: "docs";
data: InferEntrySchema<"docs">
} & { render(): Render[".md"] };
"reference/typescript/auth/attestation/functions/attestation.md": {
id: "reference/typescript/auth/attestation/functions/attestation.md";
slug: "reference/typescript/auth/attestation/functions/attestation";
"server/integrations.md": {
id: "server/integrations.md";
slug: "server/integrations";
body: string;
collection: "docs";
data: InferEntrySchema<"docs">
} & { render(): Render[".md"] };
"reference/typescript/auth/attestation/functions/fetchAttestationRequest.md": {
id: "reference/typescript/auth/attestation/functions/fetchAttestationRequest.md";
slug: "reference/typescript/auth/attestation/functions/fetchattestationrequest";
"server/introduction.md": {
id: "server/introduction.md";
slug: "server/introduction";
body: string;
collection: "docs";
data: InferEntrySchema<"docs">
} & { render(): Render[".md"] };
"reference/typescript/auth/attestation/functions/fetchAttestationResponse.md": {
id: "reference/typescript/auth/attestation/functions/fetchAttestationResponse.md";
slug: "reference/typescript/auth/attestation/functions/fetchattestationresponse";
"server/running-locally.md": {
id: "server/running-locally.md";
slug: "server/running-locally";
body: string;
collection: "docs";
data: InferEntrySchema<"docs">
Expand Down
133 changes: 133 additions & 0 deletions docs/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
clients/liquid-auth-js
clients/liquid-auth-android

# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
.pnpm-debug.log*

# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage
*.lcov

# nyc test coverage
.nyc_output

# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# Bower dependency directory (https://bower.io/)
bower_components

# node-waf configuration
.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules/
jspm_packages/

# Snowpack dependency directory (https://snowpack.dev/)
web_modules/

# TypeScript cache
*.tsbuildinfo

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Optional stylelint cache
.stylelintcache

# Microbundle cache
.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# Yarn Integrity file
.yarn-integrity

# dotenv environment variable files
.env
.env.development.local
.env.test.local
.env.production.local
.env.local

# parcel-bundler cache (https://parceljs.org/)
.cache
.parcel-cache

# Next.js build output
.next
out

# Nuxt.js build / generate output
.nuxt
dist

# Gatsby files
.cache/
# Comment in the public line in if your project uses Gatsby and not Next.js
# https://nextjs.org/blog/next-9-1#public-directory-support
# public

# vuepress build output
.vuepress/dist

# vuepress v2.x temp and cache directory
.temp
.cache

# Docusaurus cache and generated files
.docusaurus

# Serverless directories
.serverless/

# FuseBox cache
.fusebox/

# DynamoDB Local files
.dynamodb/

# TernJS port file
.tern-port

# Stores VSCode versions used for testing VSCode extensions
.vscode-test

# yarn v2
.yarn/cache
.yarn/unplugged
.yarn/build-state.yml
.yarn/install-state.gz
.pnp.*
Loading
Loading