docs(theme): bring the bootstrap theme README in line with the files it ships - #3474
Merged
Merged
Conversation
…it ships
The README of the bundled bootstrap theme described an earlier state of
the theme. This updates the statements the current tree contradicts:
- Layout: list every module under assets/, the logos, and the help/
directory; i18n/ and help/ each carry 16 locales, not en/ja only.
The stylesheet base is css/bootstrap.min.css, relative like every
other URL in the theme.
- API table: the endpoints each module actually calls. Favorites are
read with GET /favorites, the cache view calls GET /cache/{id},
clicks are logged through go/ rather than an API call, and the
password change, related queries/content and chat session deletion
were missing.
- Streaming chat example: the request field is "message" and answer
text arrives in "chunk" events as data.content.
- XSS-safety: server-supplied HTML (highlighted titles and snippets,
notifications, help sections, chat Markdown) is assigned only after
the whitelist sanitizer in format.js; it is not true that innerHTML
is used only for empty-string clears.
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.
Summary
The README of the bundled
bootstraptheme described an earlier state of the theme. This updates only the statements the current tree contradicts. Documentation only.Changes
assets/, the two logos and thehelp/directory.i18n/andhelp/each ship 16 locales (SUPPORTEDini18n.js), not justen/ja. The stylesheet note now sayscss/bootstrap.min.css, relative like every other URL in the theme since the context-path change.GET /favorites(there is noGET /documents/{id}/favorite), the cache view callsGET /cache/{id}fromcache.js, clicks are logged throughgo/rather than aPOST /click, andPOST /auth/password,GET /related-queries,GET /related-contentandDELETE /chat/sessions/{id}were missing.message(asChatRequestBodyandchat.jsuse), and answer text arrives inchunkevents asdata.content, notmessageevents withdata.token.innerHTMLis only used for empty-string clears. Highlighted titles and snippets, notifications, help sections and chat Markdown are assigned as HTML after the whitelist sanitizer informat.js; the section now describes that.The
{{themePath}}sections added in #3470 already match the tree and are unchanged.