Documentação Oficial

[amaraldavi1]

Olá Pessoal, gostaria de utilizar o framework para um projeto novo que vou realizar. Porém vejo que não existe uma documentação detalhada do fluxo de trabalho desse framework. Seria interessante ter esse tipo de tópico na Wiki, mostrando a estrutura do framework, como e onde importamos os nossos scripts, como e onde adicionamos novos arquivos .css, como utilizamos as funcionalidades que o tema traz, enfim, uma abordagem geral, diferente do que acontece na Wiki atual que apenas descreve a utilização específica de algumas funções. Coloco-me à disposição para ajudar a documentar isso, mas precisaria de alguém que já trabalhou com esse tema para ir tirando as minhas dúvidas durante o desenvolvimento do projeto. O que acham?

[mariovalney]

Olá @amaraldavi1 ! Tudo bem?

Acho que qualquer dúvida, na criação dessa documentação, pode ser postada aqui, que tentaremos te ajudar.

Abraços

[amaraldavi1]

Legal @mariovalney ! Poderíamos começar colocando esses dois pontos na Wiki, que pra quem está começando é importante saber.

• Como adicionar um JS externo ou meu próprio arquivo JS para que seja carregado no framework? E arquivos externos CSS?

• Qual um fluxo geral de trabalho com o framework?
  Exemplo:

• Extrair pasta do framework no /themes da sua instalação WP;

• Colocar suas folhas de estilos de páginas dentro de ...;

• Colocar seus JS dentro de ...;

• ...

[renanlara]

@amaraldavi1, não leve a mal a minha resposta por favor, mas isso aí tem mais a ver em saber usar as funções do WordPress do que necessariamente o Odin em si. Mas vamos lá...

1º - Para add arquivos JS e CSS use a função wp_enqueue_script() no functions.php, lá já até tem alguns que você pode usar como exemplo.

2º - É o mesmo com qualquer outro tema em WordPress, só que com a mão na roda.

3º - Não entendi.

4º - Pode criar novos arquivos .scss e dar o import no arquivo /assets/sass/style.scss

5º - Siga o 1º passo.

[mariovalney]

@amaraldavi1 entendi que sua intenção seria como fazer isso em relação aos task runners e etc... ou seja, que você iria escrever tutoriais/documentação de como fazer o clone do repositório e iniciar o desenvolvimento do tema, por exemplo.

Todavia, se for de forma geral sem relação direta com o Odin, mas sim com desenvolvimento de temas e/ou desenvolvimento com WordPress, então é como o @renanlara falou: não faz sentido criar essa documentação, já que existe a documentação do WordPress.

[amaraldavi1]

Entendi pessoal! Acho que não me fiz entender no meu comentário. Utilizei há pouco o framework Understrap. Nele para você incluir um JS, vc precisa criar o arquivo e inserir esse arquivo no task do gulpfile. Achei que seria da mesma forma no Odin.

Ficou mais claro com a resposta de @renanlara! Achei que era mais complexo.
@mariovalney O que me refiro em relação a documentação é detalhar como utilizar as funcionalidades que o tema traz. Enfim, existe alguma coisa aqui na Wiki já. Vou tentar utilizar o Odin aqui nesse novo projeto, pesquisando o que já tem e tirando as dúvidas por aqui no que eu não encontrar na Wiki. Dessa forma, a gente pode atualizar o documento da Wiki com uma ou outra informação.

De toda forma, agradeço a atenção de vocês. É assim que se constrói um framework de sucesso, com muito debate e muita documentação. Obrigado @mariovalney e @renanlara !

[amaraldavi1]

Outra coisa, já existe uma versão com o Gulp do Odin?

[renanlara]

Isso aí @amaraldavi1! Precisando pode perguntar que ficarei feliz em ajudar, faz mais de 2 anos que trabalho com o Odin, pra mim está uma maravilha. Agora respondendo a sua última pergunta, o pessoal estava discutindo sobre o Gulp aqui #411.

[amaraldavi1]

Tranquilo. Vou dar uma olhada lá. Obrigado @renanlara !

[nandomoreirame]

@amaraldavi1

Outra coisa, já existe uma versão com o Gulp do Odin?

existe esse repositório que pode ajudar https://github.com/wpbrasil/odin-gulp

[amaraldavi1]

@nandomoreirame eu vi isso, mas não entendi como usa..sou novo ainda nesse ramo. Ele só diz "Use this respository as a submodule.". Como seria isso?

[mariovalney]

https://git-scm.com/book/pt-br/v1/Ferramentas-do-Git-Submódulos