franzininho / docs-franzininho-site Goto Github PK

View Code? Open in Web Editor NEW

14.0 14.0 19.0 94.44 MB

Documentação do projeto Franzininho

Home Page: https://docs.franzininho.com.br/docs/

License: Creative Commons Attribution Share Alike 4.0 International

JavaScript 4.10% CSS 0.40% HTML 95.50%

franzininho franzininhodiy franzininhowifi hacktoberfest hacktoberfest-accepted

docs-franzininho-site's Introduction

Placa Franzininho DIY

Para mais detalhes sobre o projeto, montagem e programação, acesse a documentação

O projeto é open hardware e foi publicado em CC-BY-SA-4.0

A Franzininho DIY está certificada na OSHWA com UID BR000003

Entenda mais sobre open hardware: Open source hardware: Conheça a definição e as boas práticas

Características da Franzininho DIY

Placa em face simples - Para facilitar a fabricação caseira;
Componentes em PTH - Para montagem manual pois esse é um dos objetivos do projeto;
Microcontrolador ATtiny85-20PU - Compatibilidade com Arduino
5 pinos I/O - Todos os pinos do microcontrolador disponíveis para o usuário
LED de POWER - LED Verde para indicação da alimentação
LED Amarelo de uso geral conectado a um pino de I/O D1
Programação através da USB por Bootloader

Projeto

O projeto da PCB foi desenvolvido originalmente no Eagle CAD. Para acompanhar o histórico do projeto acesse a branch master

Todos as versões estão disponíveis nos releases

A versão atual é a V2.2. Projeto no Kicad.

Para contribuições considerar a branch main. A branch master foi mantida apenas para histórico.

Contribuição

Sugestões e Bugs no hardware

Você dever reportar bugs ou sugestões através dá área de Issues aqui no github.

Certifique-se de cumprir os seguintes critérios ao criar/enviar sua issue:

Use um título claro e descritivo para identificar o problema/sugestão.
Descreva as etapas exatas para reproduzir o problema em tantos detalhes quanto possível
Mencione o local onde este problema foi encontrado e o que sua sugestão afetará

Contribuição para melhorias no hardware

As contribuições da comunidade são sempre bem-vindas!

Esta seção destina-se a ajudar qualquer pessoa interessada em contribuir para este repositório.

Antes de contribuir, primeiro obtenha a aprovação dos mantenedores do repositório e da comunidade, levantando um problema do GitHub usando as diretrizes mencionadas na seção de sugestões.

Depois de obter aprovação, você precisará fazer os seguintes passos (estas instruções assumem que você é um usuário do GitHub).

1: fork esse repositório
2: Faça as alterações, commit e push para o fork
3: Envie o seu Pull Request

Se tiver dúvidas entre em contato

[email protected]

Siga as redes sociais e participe da comunidade

Exemplos de simulação no Wokwi

docs-franzininho-site's People

Contributors

Stargazers

Watchers

Forkers

pampaula dianasantos-ip arcostasi 3w3rt0n vilelalabs wallacejsb ggrs pyfundation carolcabral thi10 ricardojlrufino joneypereira giulianeec vinicius-a-almeida dquadros flavioipiranga marlonhenq bobypfifi

docs-franzininho-site's Issues

Automatizar deploy utilizando github actions

Migrar a documentação do Gitbook para o Docusaurus

Migrar a documentação da Franzininho DIY do Gibook Para o Docusaurus, já fazendo as atualizações necessárias

Botão de edição não funciona

Botão de editar conteúdo no github não encontra página de edição no github

[English Translation] Tradução da documentação para inglês

Olá,

Ao acessar a seção de documentação notei que apenas a página "sobre" possui tradução para o inglês, gostaria de saber:

se existe algum trabalho em andamento a respeito do resto do site
é do interesse do projeto ter toda a documentação em inglês, uma vez que o público alvo do projeto é o Brasil.

Caso não seja do interesse do projeto a tradução, gostaria de colaborar nessa atividade.

setup do Docusaurus para documentação

Site não é gerado usando Node.js 18.17.1

Realizei o clone do repositório, entrei na pasta do repositório e segui os passos:

yarn install
yarn start

O resultado do último comando foi:

Browserslist: caniuse-lite is outdated. Please run:
  npx browserslist@latest --update-db
  Why you should do it regularly: https://github.com/browserslist/browserslist#browsers-data-updating
node:internal/crypto/hash:69
  this[kHandle] = new _Hash(algorithm, xofLen);
                  ^

Error: error:0308010C:digital envelope routines::unsupported
    at new Hash (node:internal/crypto/hash:69:19)
    at Object.createHash (node:crypto:133:10)
    at module.exports (/home/ubuntu/playground/docs-franzininho-site/node_modules/webpack/lib/util/createHash.js:135:53)
    at NormalModule._initBuildHash (/home/ubuntu/playground/docs-franzininho-site/node_modules/webpack/lib/NormalModule.js:417:16)
    at handleParseError (/home/ubuntu/playground/docs-franzininho-site/node_modules/webpack/lib/NormalModule.js:471:10)
    at /home/ubuntu/playground/docs-franzininho-site/node_modules/webpack/lib/NormalModule.js:503:5
    at /home/ubuntu/playground/docs-franzininho-site/node_modules/webpack/lib/NormalModule.js:358:12
    at /home/ubuntu/playground/docs-franzininho-site/node_modules/loader-runner/lib/LoaderRunner.js:373:3
    at iterateNormalLoaders (/home/ubuntu/playground/docs-franzininho-site/node_modules/loader-runner/lib/LoaderRunner.js:214:10)
    at Array.<anonymous> (/home/ubuntu/playground/docs-franzininho-site/node_modules/loader-runner/lib/LoaderRunner.js:205:4)
    at Storage.finished (/home/ubuntu/playground/docs-franzininho-site/node_modules/enhanced-resolve/lib/CachedInputFileSystem.js:55:16)
    at /home/ubuntu/playground/docs-franzininho-site/node_modules/enhanced-resolve/lib/CachedInputFileSystem.js:91:9
    at /home/ubuntu/playground/docs-franzininho-site/node_modules/graceful-fs/graceful-fs.js:123:16
    at FSReqCallback.readFileAfterClose [as oncomplete] (node:internal/fs/read_file_context:68:3) {
  opensslErrorStack: [ 'error:03000086:digital envelope routines::initialization error' ],
  library: 'digital envelope routines',
  reason: 'unsupported',
  code: 'ERR_OSSL_EVP_UNSUPPORTED'
}

Node.js v18.17.1
error Command failed with exit code 1.

Para resolver o error foi preciso utilizar: export NODE_OPTIONS=--openssl-legacy-provider

Após realizar uma rápida pesquisa encontrei uma issue do docusaurus(leoafarias/fvm@8baf402), ela recomenda utilizar uma versão mais atual. Ao utilizar a change dessa issue o site foi gerado com sucesso.

Entretanto isso me levou a verificar a versão mais atual do docusaurus e vi que ele está na 3.1.1.

Gostaria de saber o que acham a respeito de realizar uma atualização para a versão 3.1.1.

Alterar CNAME para docs.franzininho.com.br

Podemos alterar o endereço de https://franzininho.github.io/docs-franzininho-site/docs para https://docs.franzininho.com.br de maneira simples e gratuita no github pages.

Basta criar um arquivo chamado CNAME contendo o próprio site, e apontar o subdominio como CNAME pelo DNS

Exemplo

Github	Cloudflare