Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
c4eb7e3
Add utility functions for formatting CPF, CNPJ, and phone numbers
enzosakamoto Oct 23, 2025
bbda11d
chore: remove unused document formatting functions for CPF, CNPJ, and…
enzosakamoto Oct 23, 2025
b18bcde
refactor: replace document type string literals with enum values and …
enzosakamoto Oct 23, 2025
82dd08c
refactor: replace string literals with enum values for document type …
enzosakamoto Oct 23, 2025
3eb6de3
refactor: update user info page to use new string-extensions for docu…
enzosakamoto Oct 23, 2025
f4d0645
feat: add linkedin links for team members and update navigation to us…
enzosakamoto Oct 23, 2025
d290cea
refactor: update color variables for improved contrast and consistenc…
enzosakamoto Oct 23, 2025
931ed8c
refactor: update sidebar component styles for improved border definition
enzosakamoto Oct 23, 2025
2f896ba
fix: improve error handling in create base pipeline process
enzosakamoto Oct 23, 2025
f9736cd
refactor: update styles for knowledge base detail modal for improved …
enzosakamoto Oct 23, 2025
744aa28
refactor: update sidebar component border color for improved visibility
enzosakamoto Oct 23, 2025
e1b3ee3
Merge pull request #68 from knowlyai/fix/person-type-bugs
enzosakamoto Oct 23, 2025
46d0381
Initial plan
Copilot Oct 23, 2025
5edfd90
Modernize home page with enhanced hero section and improved visual de…
Copilot Oct 23, 2025
9a934bd
refactor: update navbar links to use Link component for improved routing
enzosakamoto Oct 23, 2025
85d5195
fix: update role for Izabel Sampaio Goes and adjust layout styles on …
enzosakamoto Oct 23, 2025
a535afc
Add Getting Started documentation page with step-by-step instructions
Copilot Oct 23, 2025
1f3bdeb
Add integration sub-pages for API, WhatsApp Business, and Instagram w…
Copilot Oct 23, 2025
068bf4d
Update API code snippets across all integration docs to match actual …
Copilot Oct 23, 2025
d98ee79
Add Next Steps documentation page with roadmap for multi-tenant chatb…
Copilot Oct 23, 2025
a4569b4
Remove emojis from Next Steps documentation page
Copilot Oct 23, 2025
eb09863
refactor: improve formatting and readability in documentation pages
enzosakamoto Oct 23, 2025
465069c
Merge pull request #70 from knowlyai/copilot/modernize-home-page-ui
enzosakamoto Oct 23, 2025
d9284ef
fix: update anchor links in navbar to use absolute paths
enzosakamoto Oct 23, 2025
423df2e
fix: improve error handling in message sending process
enzosakamoto Oct 24, 2025
c3fc1cf
feat: add loading message and improve message handling in chat
enzosakamoto Oct 24, 2025
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
360 changes: 360 additions & 0 deletions src/features/docs/pages/getting-started.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,360 @@
import { motion } from 'framer-motion'
import { h1, h2, p, ul, li, pre } from '@/shared/components/typography'

export function GettingStartedPage() {
return (
<motion.div
initial={{ opacity: 0, y: 20 }}
animate={{ opacity: 1, y: 0 }}
transition={{ duration: 0.5 }}
>
{h1({ children: 'Comece a Usar o Knowly' })}

{p({
children: (
<>
Siga este guia passo a passo para começar a usar a plataforma Knowly
e criar sua primeira base de conhecimento de IA.
</>
)
})}

{h2({ children: 'Passo 1: Criar uma Conta' })}
{p({
children: (
<>Para começar, você precisa criar uma conta gratuita no Knowly:</>
)
})}
{ul({
children: (
<>
{li({
children: (
<>
Acesse a página de{' '}
<strong>
<a href="/sign-up">cadastro</a>
</strong>
</>
)
})}
{li({
children: <>Preencha seus dados: nome, e-mail e senha</>
})}
{li({
children: <>Confirme seu e-mail através do link enviado</>
})}
{li({
children: (
<>
Faça <strong>login</strong> com suas credenciais
</>
)
})}
</>
)
})}

{h2({ children: 'Passo 2: Criar uma Base de Conhecimento' })}
{p({
children: (
<>
Após fazer login, você pode criar sua primeira base de conhecimento:
</>
)
})}
{ul({
children: (
<>
{li({
children: (
<>
Acesse <strong>&quot;Minhas Bases&quot;</strong> no menu do
usuário
</>
)
})}
{li({
children: (
<>
Clique em <strong>&quot;Nova Base&quot;</strong>
</>
)
})}
{li({
children: (
<>
Escolha um <strong>nome</strong> para sua base
</>
)
})}
{li({
children: (
<>
Selecione o <strong>modelo de IA</strong> que deseja usar (ex:
Amazon Bedrock)
</>
)
})}
{li({
children: (
<>
Faça <strong>upload dos documentos PDF</strong> que servirão
como base de conhecimento
</>
)
})}
{li({
children: (
<>
Clique em <strong>&quot;Criar Base&quot;</strong>
</>
)
})}
</>
)
})}

{p({
children: (
<>
Aguarde alguns instantes enquanto o sistema processa seus
documentos. O tempo varia conforme a quantidade e tamanho dos
arquivos.
</>
)
})}

{h2({ children: 'Passo 3: Obter a Chave da Base' })}
{p({
children: (
<>
Depois que sua base estiver pronta, você precisa obter a chave de
API para integrá-la:
</>
)
})}
{ul({
children: (
<>
{li({
children: <>Na lista de bases, clique na base que você criou</>
})}
{li({
children: (
<>
Na página de detalhes, copie a <strong>Chave da Base</strong>{' '}
(Base ID)
</>
)
})}
{li({
children: (
<>
Copie também sua <strong>Chave de API</strong> (API Key) nas
configurações da conta
</>
)
})}
</>
)
})}

{p({
children: (
<>
<strong>Importante:</strong> Guarde essas chaves em um local seguro.
Você precisará delas para fazer requisições à API.
</>
)
})}

{h2({ children: 'Passo 4: Testar no Playground' })}
{p({
children: (
<>
Antes de integrar, você pode testar sua base de conhecimento no
Playground:
</>
)
})}
{ul({
children: (
<>
{li({
children: (
<>
Clique em <strong>&quot;Testar no Playground&quot;</strong> na
página da base
</>
)
})}
{li({
children: (
<>
Digite perguntas relacionadas aos documentos que você enviou
</>
)
})}
{li({
children: (
<>
Veja as respostas geradas pela IA com base no conhecimento da
sua base
</>
)
})}
</>
)
})}

{h2({ children: 'Passo 5: Integrar com seu Código' })}
{p({
children: (
<>
Agora você pode integrar a base de conhecimento ao seu sistema
usando nossa API REST:
</>
)
})}

{pre({
children: `# Exemplo usando cURL
curl -X POST https://api.knowly.dev.br/chat \\
-H "Content-Type: application/json" \\
-d '{
"kb_key": "knowly_c81a7410-4c69-45e2-b6c6-79205c3a99fd",
"model": "MISTRAL_SMALL",
"prompt": "Qual é o horário de atendimento?"
}'`
})}

{p({
children: (
<>
<strong>Exemplo em JavaScript/Node.js:</strong>
</>
)
})}

{pre({
children: `fetch('https://api.knowly.dev.br/chat', {
method: 'POST',
headers: {
'Content-Type': 'application/json'
},
body: JSON.stringify({
kb_key: 'knowly_c81a7410-4c69-45e2-b6c6-79205c3a99fd',
model: 'MISTRAL_SMALL',
prompt: 'Qual é o horário de atendimento?'
})
})
.then(response => response.json())
.then(data => console.log(data.response));`
})}

{p({
children: (
<>
<strong>Exemplo em Python:</strong>
</>
)
})}

{pre({
children: `import requests

response = requests.post(
'https://api.knowly.dev.br/chat',
headers={
'Content-Type': 'application/json',
},
json={
'kb_key': 'knowly_c81a7410-4c69-45e2-b6c6-79205c3a99fd',
'model': 'MISTRAL_SMALL',
'prompt': 'Qual é o horário de atendimento?'
}
)

data = response.json()
print(data['response'])`
})}

{h2({ children: 'Próximos Passos' })}
{p({
children: (
<>
Agora que você já sabe como começar, explore mais recursos da
plataforma:
</>
)
})}
{ul({
children: (
<>
{li({
children: (
<>
Aprenda mais sobre{' '}
<strong>
<a href="/docs/foundation-models">Modelos de Fundação</a>
</strong>
</>
)
})}
{li({
children: (
<>
Veja detalhes sobre{' '}
<strong>
<a href="/docs/knowledge-bases">
Gerenciamento de Bases de Conhecimento
</a>
</strong>
</>
)
})}
{li({
children: (
<>
Explore opções avançadas de{' '}
<strong>
<a href="/docs/integration">Integração</a>
</strong>
</>
)
})}
{li({
children: (
<>
Gerencie sua{' '}
<strong>
<a href="/docs/subscription-management">Assinatura</a>
</strong>
</>
)
})}
</>
)
})}

{p({
children: (
<>
Precisa de ajuda? Consulte nossa{' '}
<strong>
<a href="/faq">página de FAQ</a>
</strong>{' '}
ou entre em{' '}
<strong>
<a href="/faq/contact">contato</a>
</strong>
.
</>
)
})}
</motion.div>
)
}

export default GettingStartedPage
Loading