Commit Graph

184 Commits

Author SHA1 Message Date
RMidhunSuresh
c07a42292c Include Platform change in sdk docs 2022-04-27 12:28:48 +05:30
Bruno Windels
480c5c1584 update SDK docs with new style location 2022-04-14 13:49:54 +02:00
RMidhunSuresh
2dc9b63051 Update node version in FAQ 2022-01-17 12:49:55 +05:30
Bruno Windels
8c1596d869 update SDK docs to not use paths/vite anymore 2022-01-12 18:32:15 +01:00
Bruno Windels
68214156d9
Merge pull request #608 from vector-im/ts-migration-doc
Clarify approach to type data objects in doc
2022-01-06 14:39:06 +01:00
Bruno Windels
13e77636a9 export paths from vite.js as required by Platform, reorder ctor params
make it easier for SDK users
2021-12-22 17:48:08 +01:00
Bruno Windels
24afe1e496 add licenses to readme of things we actually bundle
rather than just depend on
2021-12-22 16:45:08 +01:00
Bruno Windels
c3ff571af7 update SDK doc, use it as sdk package readme 2021-12-22 16:31:19 +01:00
RMidhunSuresh
10368500f2 Fix formatting 2021-12-10 12:12:52 +05:30
RMidhunSuresh
5ef7ab32df Update doc 2021-12-10 12:09:18 +05:30
RMidhunSuresh
ef3456199c Fix formatting 2021-12-01 22:52:09 +05:30
R Midhun Suresh
928a5c27f3
Add rationale
Co-authored-by: Bruno Windels <brunow@matrix.org>
2021-12-01 22:50:59 +05:30
Bruno Windels
bc86bf2d00 some more sdk impl notes 2021-12-01 18:11:09 +01:00
Bruno Windels
70c1e4e3ed move doc paragraphs around 2021-12-01 14:06:05 +01:00
RMidhunSuresh
73ca2dfb77 Add Record and fix typo 2021-12-01 16:05:16 +05:30
Bruno Windels
49443d4f6e
Update TS-MIGRATION.md 2021-11-30 14:17:51 +00:00
Bruno Windels
2e57e99e34
clarify when to use type and interface 2021-11-30 14:15:25 +00:00
Bruno Windels
6980921dab
some impl notes for SDK 2021-11-18 14:16:10 +00:00
Moritz Dietz
c83f78044e
Update FAQ to highlight about the existence of published builds 2021-10-20 12:46:37 +02:00
Bruno Windels
82aac93f36
Update SDK.md 2021-10-20 07:05:39 +00:00
Bruno Windels
39d5073f49 remove user and password 2021-10-01 13:37:37 +02:00
Bruno Windels
23da4ae2dd point to SDK docs from FAQ 2021-10-01 13:27:58 +02:00
Bruno Windels
675ee59e50 Add instructions and example code for basic SDK usage 2021-10-01 13:26:14 +02:00
Bruno Windels
193a0e1a4f move UI docs to doc folder 2021-10-01 13:26:03 +02:00
Bruno Windels
ae5a4f0051 start doc with additional steps for migration
once the base migration is done
2021-09-06 13:07:47 +02:00
Bruno Windels
0a13c12b1f
Update FAQ.md
mention olm issues when integrating for now
2021-08-31 12:16:59 +00:00
Bruno Windels
c3177b06bf
Merge pull request #418 from vector-im/replies
Sending replies
2021-08-06 21:28:42 +00:00
Danila Fedorin
d4ed146cd7 Add implementation thoughts 2021-07-29 13:40:02 -07:00
Moritz Dietz
9a7cb2fd31
Apply review suggestion 2021-07-29 11:54:04 +02:00
Moritz Dietz
699e704a49
docs: Update FAQ to add missing yarn install command
Add yarn install to the FAQ docs

As someone who has never worked with either npm or yarn I was not aware that I need to run yarn install as well.
After having a chat in the Hydrogen room I was walked through to help me build hydrogen.

Either you initially meant to say yarn install instead of yarn init or it was assumed that one would run yarn install anyway.
2021-07-27 21:00:47 +02:00
Danila Fedorin
73ca5d21ff Add ideas of pending replies 2021-07-23 15:32:37 -07:00
Bruno Windels
dbaef5117a
Merge pull request #384 from vector-im/bwindels/reactions
Reactions
2021-06-24 15:01:44 +00:00
Bruno Windels
c3848ff56b
Update FAQ.md 2021-06-08 07:12:10 +00:00
Bruno Windels
eab3c2d6dd update relation notes 2021-06-03 21:00:09 +02:00
Bruno Windels
934839574e
Update FAQ.md 2021-06-03 10:16:12 +00:00
Bruno Windels
09cfd2a10a
Update FAQ.md 2021-06-03 10:15:35 +00:00
Bruno Windels
ecde6ed919
Update FAQ.md 2021-06-03 10:14:58 +00:00
Bruno Windels
eec7ceb765
remove not being able to leave rooms 2021-06-03 10:13:37 +00:00
Bruno Windels
a39d26a3e0
clarify browser support 2021-06-03 10:11:50 +00:00
Bruno Windels
eb8fdf5c27 some notes on how to implement relations 2021-05-19 12:01:58 +02:00
Germain
62231b7833
Fix links to Matrix documentation 2021-04-30 11:58:29 +01:00
Bruno Windels
aea59f8974
Merge pull request #272 from jcgruenhage/jcgruenhage/new-dockerfile
New production Dockerfile and GitLab CI definition
2021-04-28 11:13:14 +02:00
Bruno Windels
03d92b687e doc with design rationale 2021-04-20 13:02:33 +02:00
Bruno Windels
2a0045bed7 support override main css file 2021-03-25 18:54:10 +01:00
Bruno Windels
cd615265f8 support overriding imports for customizations 2021-03-25 18:08:47 +01:00
Bruno Windels
2fb255d2ec dot down some notes wrt to push 2021-03-23 18:20:23 +01:00
Bruno Windels
13bf4aadc6 some notes on how SSO should work 2021-03-23 12:32:24 +01:00
Bruno Windels
5a4afc8f4b some notes wrt to ideas for read receipts 2021-03-18 20:22:02 +01:00
Jan Christian Grünhage
bc2e7a7366 chore: optimise Dockerfile
So far, the Dockerfile built hydrogen on the server running the image,
instead of building it during the building of the image. This blew up
the image size immensely and caused node+yarn to run in the resulting
image. This new Dockerfile builds hydrogen in a separate build stage and
then moves the target directory into an nginx based container image,
which takes care of serving the target webroot.

The existing Dockerfile has been moved to Dockerfile-dev for usage as a
development environment. The docs have been adjusted accordingly.

Additionally, this switched from a fixed alpine version of the node
image to the latest alpine version, and changed the container image
references in the `FROM` statements to use the fully qualified
references including the registry domain.
2021-03-14 12:52:35 +01:00
Bruno Windels
f9979b1a77 more notes on relations 2021-03-08 22:25:18 +01:00
Bruno Windels
571bedd76d doc improvement 2021-03-04 19:50:23 +01:00
Bruno Windels
e1eb313ffa some notes for implementing relations 2021-03-01 15:07:24 +01:00
Bruno Windels
c18a7175b7 some notes wrt to #248 / backfills 2021-03-01 15:07:24 +01:00
Bruno Windels
62863c5eaf
Update FAQ.md 2021-03-01 10:07:28 +00:00
Bruno Windels
068d25266c
Update FAQ.md 2021-02-22 09:20:59 +00:00
Bruno Windels
b5eb0e752b
Update FAQ.md 2021-02-22 09:19:52 +00:00
Bruno Windels
5652b78c50
Update FAQ.md 2021-02-22 09:17:58 +00:00
Bruno Windels
430da8766f docker instructions 2021-02-08 12:43:53 +01:00
Bruno Windels
977b9c282d add FAQ 2021-01-25 10:35:13 +01:00
Bruno Windels
c1df371a14 add some documentation for our idb investigations 2020-10-01 16:14:58 +02:00
Bruno Windels
9ff4f3839c Merge branch 'master' into bwindels/memberlist 2020-08-19 12:13:38 +02:00
Bruno Windels
b68a782f10 doc improvements 2020-08-18 17:28:08 +02:00
Bruno Windels
f5d3092031 WIP 2020-06-26 23:26:24 +02:00
Bruno Windels
625598be90 add olm api decls link to doc 2020-06-25 00:14:57 +02:00
Bruno Windels
5ebd6bb092 resolve doubt 2020-06-25 00:09:58 +02:00
Bruno Windels
b96b68a11e doc changes 2020-06-24 22:43:46 +02:00
Bruno Windels
464615ab21 update notes 2020-05-26 10:30:30 +02:00
Bruno Windels
209aa77a2e add some e2ee impl notes 2020-05-13 10:20:53 +02:00
Bruno Windels
070a0d3d98 some notes 2020-05-08 09:12:41 +02:00
Bruno Windels
32710de12a
Merge pull request #43 from bwindels/bwindels/reconnect
Reconnect after network failure
2020-05-07 18:06:41 +00:00
Bruno Windels
f56b96b0ff add some ideas for relations 2020-05-07 19:14:53 +02:00
Bruno Windels
f476ac0dae some notes 2020-05-07 18:47:01 +02:00
Bruno Windels
328000059f update notes 2020-05-05 23:20:03 +02:00
Bruno Windels
34549a2ecb css notes 2020-04-30 18:28:35 +02:00
Bruno Windels
f4bb609ab6 notes 2020-04-29 10:10:33 +02:00
Bruno Windels
8bde627cdb more WIP 2020-04-29 10:10:20 +02:00
Bruno Windels
e6ae60abb4 notes about how view updates work and should work 2020-04-29 10:05:07 +02:00
Bruno Windels
067027d376 note updates 2020-04-22 20:54:17 +02:00
Bruno Windels
69a8786f8f update notes 2020-04-20 23:10:54 +02:00
Bruno Windels
ad7c564d5d notes 2020-04-20 21:43:02 +02:00
Bruno Windels
0f29fdb24e some notes 2020-04-20 21:27:07 +02:00
Bruno Windels
164d9d594f finish implemenation of SessionContainer 2020-04-20 19:48:21 +02:00
Bruno Windels
72b0eefccb replace isSyncing and emit with an Observable SyncStatus 2020-04-19 19:52:26 +02:00
Bruno Windels
80f7caadbe rename SessionsStore to SessionInfoStorage 2020-04-19 19:13:38 +02:00
Bruno Windels
8c5411cb7d moar WIP 2020-04-19 19:02:10 +02:00
Bruno Windels
1f15ca6498 more WIP 2020-04-18 19:16:16 +02:00
Bruno Windels
cc6b952209 e2ee note additions 2020-04-09 18:36:38 +02:00
Bruno Windels
ef267ca331 WIP2 2020-04-05 15:11:15 +02:00
Bruno Windels
00d27b1a47 more notes 2020-04-04 17:06:53 +02:00
Bruno Windels
65cca83f7f notes how to implement reconnecting and status reporting 2020-03-30 22:24:38 +02:00
Bruno Windels
234c260339 dont modify fragments in comparer until txn succeeds 2020-03-30 20:46:52 +02:00
Bruno Windels
9b2f282534 move docs about how to implement something to subdir 2020-03-28 12:36:19 +01:00
Bruno Windels
089d2fe430 some notes on the general idea of persisting network calls in brawl 2020-03-28 12:33:56 +01:00
Bruno Windels
b8eea881f8 some notes on how we might implement members and display names 2020-03-28 12:33:34 +01:00
Bruno Windels
8eea6e7296
Update e2e.md 2020-03-10 17:34:45 +00:00
Bruno Windels
738b8202be wrote docs about how to do invites and e2ee 2019-10-23 09:42:44 +02:00
Bruno Windels
2ce0f6e30e document steps needed to implement e2e 2019-10-17 22:40:26 +02:00
Bruno Windels
610e83f2dd update todo list 2019-09-15 12:22:13 +02:00
Bruno Windels
49a577991b login and session picker view models, sessions store 2019-07-31 00:06:53 +02:00
Bruno Windels
3ed72df620 put everything together to make it roughly work
no local echo yet, and send errors are being swallowed
2019-07-27 10:51:51 +02:00