docs: a README for the people who play, with both windows - #8
Merged
Merged
Conversation
O arquivo abria com escopos de setting e escondia o Install na linha 130. Quem chega quer instalar primeiro. Install sobe para o topo, com o caminho dentro do Foundry e o passo de ligar o modulo no mundo. Os titulos deixam o jargao: "The three scopes" vira "What a profile carries", "Tags that are not versions" vira "Releases it cannot read", "Credentials" vira "Passwords and keys", "From a macro" vira "The API, for macros and modules" e desce para junto das secoes de quem desenvolve. Duas capturas de tela entram, tiradas de um Foundry v14 de verdade: a janela do cofre e a de atualizacoes. O manifesto aponta `readme` para dentro da pasta do modulo, entao `docs` entra no zip junto, senao a imagem quebra para quem instala. O bloco de macro declarava `report` duas vezes e nao rodava. E o numero de checagens do e2e estava em 26; sao 32, e agora inclui a passagem entre mundos.
Everything tracked in this repo is written in English.
fcsouza
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The README opened with setting scopes and hid Install at line 130. Someone who lands here wants to install first.
What changes
Two defects along the way
const reporttwice. Pasted into a macro, it did not run.One thing that is not text
module.jsonpointsreadmeat a path inside the module folder, so Foundry reads that README from there. An image underdocs/only resolves ifdocs/ships in the zip, so it went intostaticAssets. The zip goes from 66 KB to 280 KB.Checked:
unzip -llistsdocs/vault-window.pnganddocs/updates-window.pngat the package root.No fact in the README changed, only the order and the words.