google/comprehensive-rust

Rewrite speaker note system

Open

#1.232 aberto em 22 de set. de 2023

Ver no GitHub
 (1 comment) (0 reactions) (0 assignees)Rust (2.009 forks)batch import
good first issuehelp wanted

Métricas do repositório

Stars
 (32.954 stars)
Métricas de merge de PR
 (Mesclagem média 9d 23h) (36 fundiu PRs em 30d)

Description

The speaker-notes.js file is a little home-grown system for injecting speaker notes to the pages.

I would like to rewrite this to use a more modern development style:

  • we should minimize the code when publishing the course
  • we should make the label ("Speaker Notes") translatable!
  • we could perhaps use a library for some of the state logic?
  • we could take advantage of https://github.com/google/mdbook-i18n-helpers/issues/70 when it's ready to do less on the fly DOM manipulation

Guia do colaborador

Direção de pesquisa
Examine a implementação atual do speaker notes.js, entenda como ele injeta notas do apresentador e, em seguida, projete um substituto modular que reduza o tamanho do código, torne os rótulos traduzíveis (usando mdbook i18n helpers quando disponível) e, opcionalmente, use uma biblioteca de gerenciamento de estado. Foco em minimizar a manipulação do DOM em tempo de execução.
Pilha de tecnologia
javascript
Domain
frontend
Tipo Issue
Refatoração
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
4
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-2 dias
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
JavaScriptDOM manipulation
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
40