Comments (19)
Muito bom @chambber,
Pensei em abordar alguns assuntos:
- Get Started
- instalando o horse
- iniciando seu servidor
- Methods HTTP
- GET
- PUT
- DELETE
- POST
- Requests
- ParamID
- QueryParam
- Body
- Headers
- Response
- Send
- StatusCode
- Headers
- Avançados
- Roteamento
- Middlewares
- Segurança
- Sessões
- Json
- Log
- Tools
- Boss
Em relação a tradução e documentação podemos criar uma pasta /docs dentro do repositório principal do horse, mas é apenas uma sugestão, se você achar melhor criarmos um repositório a parte podemos faze-lo.
O Netlify, atenderia de maneira free as necessidades que você julga básicas?
Sugestões sempre são bem vindas.
from horse-doc.
Sobre o repositório estava pensando sobre a pasta /docs também, porém se fosse simplesmente os arquivos estáticos. Como terá um projeto inteiro com suas próprias dependências referentes ao hexo, isso me leva a pensar que seria melhor um a parte.
Quanto ao Netlify a ideia seria facilitar, configurando um continuous deployment que creio que facilitaria o fluxo de atualização da documentação. Portanto o gratuito já atenderia.
from horse-doc.
Bom dia, fica tranquilo sabemos bem como é ter a semana corrida 😉
Muito boa a ídeia de explorar a API exemplificando os métodos.
Referente às perguntas:
-
Os parâmetros não fazem validações de expressões regulares? Atualmente não faz validação por regex, mas é uma excelente feature, podemos colocar no roadmap do horse, ainda em construção.
-
Quando eu não quiser a continuação do próximo Callback, devo lançar uma exceção como por exemplo, EHorseCallbackInterrupted? Sim, hoje a parada do callback é forçada por esta exception.
from horse-doc.
Boa noite nobre @chambber ,
Fico feliz que o projeto tenha despertado sua atenção, a essência do Horse foi claramente descrita no seu comentário.
Referente a documentação e home page, são alguns dos itens que estão no roadmap do Horse, assim que possível vamos criar um roadmap oficial aqui no github, onde vai facilitar a contribuição de pessoas interessadas.
Atualmente não temos ninguém desenvolvendo estes itens, se você quiser criar uma documentação e uma home page, vai ser de grande ajuda para a comunidade.
from horse-doc.
Decobri por acaso pois precisei acessei o template do gitignore do GitHub, e vi lá um gerenciador de dependências e todos os projetos relacionados aqui, e me chamou muita a atenção esse projeto.
Quanto a home page com a documentação, posso estar fazendo, em relação a esses itens, ferramentas a serem utilizadas, como pretendem fazer, tem algo em mente?
from horse-doc.
Que legal, isso o gitignore.io já contempla a pasta modules do boss..
Referente a home page e a documentação, pensamos em usar o git pages.
from horse-doc.
Entendi, considerando isso, algo como um gerador estático, como docsify, ou até um hexo, algo desse tipo?
from horse-doc.
Eu particularmente gosto muito da estrutura do hexo, mas gostaria de deixar livre a decisão de escolha para você.
from horse-doc.
Tudo bem, estarei usando o hexo para o projeto, estarei começando então.
from horse-doc.
Estou com o projeto inicial montado, dito isso queria discutir:
- O que acham?
- Pontos a serem abordados na documentação.
- Repositório para documentação.
- Internacionalização no mesmo repositório ou separado?
- Possibilidade de usar o Netlify.
from horse-doc.
Boa ideia,
Criamos um repositório específico para este projeto.
from horse-doc.
Sobre o andamento da tarefa:
- Implementei suporte a vários idiomas na documentação,
- Configurei a integração com o Netlify com redirecionamento de idioma e desenvolvimento contínuo no master.
Nessa semana estarei finalizando a documentação seguindo os assuntos mencionados.
Quanto a documentação em inglês não tenho conhecimento suficiente para escrevê-la, mas estou preparando os arquivos para ficar fácil de serem traduzidos, tudo bem?
A documentação está usando um domínio gratuito por enquanto, não sei como pretendem fazer em relação a domínio.
from horse-doc.
Muito bom,
A integração com o Netlify vai facilitar muito nossa vida em relação aos deploys e contribuições.
Referente a documentação em inglês, aconselho deixar tudo traduzido automaticamente pelo google translate, logo depois podemos ir ajustando a mesma para fazer mais sentido.
Hoje possuimos o dominio hashload.com, é possivel criarmos o dominio horse.hashload.com.
from horse-doc.
Certo, deixarei com tradução automática.
Sobre o domínio, tudo bem, estarei alterando para horse.hashload.com.
from horse-doc.
Referente ao domínio, como posso configurar o apontamento?
from horse-doc.
A configuração de DNS seria as seguintes:
- dns1.p06.nsone.net
- dns2.p06.nsone.net
- dns3.p06.nsone.net
- dns4.p06.nsone.net
from horse-doc.
DNS apontado.
from horse-doc.
Boa tarde,
@chambber eu criei uma issue, para referenciar a documentação ao projeto principal, pois não tive tempo para fazer o mesmo.
Caso tenha disponibilidade, pensei em refazermos o README.MD para algo mais intuitivo e com mais informações.
from horse-doc.
Boa noite,
Semana corrida, não consegui te responder, desculpe-me.
Quanto a documentação estou escrevendo e também criando uma API de todos os métodos disponíveis.
Atualmente criei algumas aplicações para testar as funcionalidades para poder entender melhor e escrever sobre e queria confirmar algumas coisas:
- Os parâmetros não fazem validações de expressões regulares?
- Quando eu não quiser a continuação do próximo Callback, devo lançar uma exceção como por exemplo,
EHorseCallbackInterrupted
?
Quanto ao README tinha pensado sim, e posso sim.
from horse-doc.
Related Issues (8)
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from horse-doc.