Commit Graph

102 Commits

Author SHA1 Message Date
Gabriel Horner
1765ecfb02 Fix duplicates that were caught by linter
Also undo removals in this PR of translations that were being used.
Also changed :misc/copy translation since it didn't have a meaningful
description
2023-06-05 14:00:11 -04:00
Gabriel Horner
2d60d95bc5 Update lang validation to detect duplicates
There are still a few to remove.
Remove lang:duplicates as it's now included in the linter
2023-06-05 11:09:35 -04:00
Gabriel Horner
f5771d293f Update doc missed in #9516 2023-05-30 11:58:41 -04:00
Gabriel Horner
ad3eda7c25 Tutorial fix and refactor. Update docs
* Some langs like es didn't have tutorials translated and were
  pretending to
* it lang had tutorials but they weren't being used
* Moved tutorials to the more appropriate src/resources/tutorials
* Also fixed typos and bb task
2023-05-24 16:57:48 -04:00
Gabriel Horner
514b5faf6e Refactor and simplify dicts
- frontend.dicts encapsulates dicts behavior for all other namespaces
- Each dict ns only has one var which prepares us
- No longer need shortcut.dicts
- Fix remaining lints that were broken
- Also bring back frontend.dicts
- Update guide
- Add a false binding to :editor/toggle-undo-redo-mode which throws a
  needless warning
2023-05-18 18:13:50 -04:00
Avelino
69bbf044a9 docs/lang: describe how to add a new language
Signed-off-by: Avelino <avelinorun@gmail.com>
2023-05-18 18:05:22 -04:00
Avelino
1d14f6a98f centralize translation dictionary
Signed-off-by: Avelino <avelinorun@gmail.com>
2023-05-18 18:05:22 -04:00
Avelino
184ace5ad6 update documentation to new translation structure (standalone package)
Signed-off-by: Avelino <avelinorun@gmail.com>
2023-05-18 18:05:22 -04:00
Gabriel Horner
8fca36629f Document repl test workflow as a followup to #9372
Also organized unit test sections more
2023-05-16 14:25:26 -04:00
Gabriel Horner
f645daf724 Add a --copy to support suggested translation workflow
Follow up to #9115
2023-04-17 10:53:43 -04:00
hasecilu
20b2e06427 Improve contributing-to-translations doc 2023-04-17 10:53:04 -04:00
Gabriel Horner
2697f2b588 Improve doc wording for https://github.com/logseq/logseq/pull/9070\#issuecomment-1505816096 2023-04-14 11:37:05 -04:00
Gabriel Horner
50ff53ea72 Mention setup required for bb command 2023-04-09 23:13:33 +08:00
Gabriel Horner
fef07fe812 Add docs and workflow for dep
Also rename dep to publishing for consistency with existing names
2023-04-09 23:13:33 +08:00
Adam Hupp
34e806999f Simplify Windows development docs (#8857)
* Simplify Windows development docs

This PR simplifies the Windows development setup documentation, specifically:

 * Uses `winget` for installing pre-requisites.  This is installed by default on modern windows and is now the "standard" package manager.
 * Use clj-msi to install clj.exe, rather than the clojure-tools powershell module.  This allows the build to work without modifying package.json
 * Remove build instructions that are out of date and now inconsistent with the develop-logseq.md doc.

* Update develop-logseq-on-windows.md

Include scoop and chocolately instructions, explicitly redirect to develop-logseq.md for build info.
2023-04-05 12:56:48 -04:00
Gabriel Horner
06fa65861f Minor clean up and help with feedback
- basic clj-kondo config and cleanup unused binding
- Add some unit tests
- Add a basic readme
2023-03-28 09:14:42 +08:00
Zhizhen He
ac4e2a1b48 docs: format table and update command 2023-03-20 12:57:47 +08:00
Konstantinos
2cace8894c Enhance: Add more translations, remove unused ones and add linter for unused (#8568)
* chore: remove unused dictionary keys

* wip: add dictionary keys for hardcoded strings

* resolve conflicts

* Add linter to detect :en ui translation keys match used ones

- Fix a couple entries caught by linter
- Copy :command.editor/open-link-in-sidebar entries to
  :help/open-link-in-sidebar as translation keys shouldn't be reused in
  multiple contexts, especially when it's across ui and shortcut dicts

* fix: remove dead keys

* chore: reuse dict keys

* chore: reintroduce useful keys

---------

Co-authored-by: Gabriel Horner <gabriel@logseq.com>
2023-02-24 09:21:57 -05:00
Gabriel Horner
b78c689458 Fix remaining todos and add a section to practices about this new action 2023-02-21 12:01:58 -05:00
Zhizhen He
25c15053d6 feat: add typos to GitHub action
Signed-off-by: Zhizhen He <hezhizhen.yi@gmail.com>
2023-02-21 12:01:58 -05:00
Andelf
f6d4560044 ci: update actions and build deps 2023-02-22 00:32:05 +08:00
Bad3r
ebb2a5c1d7 chore(dep): bump NodeJS from 16.x to 18.x LTS (#8406)
* chore(dep): bump NodeJS to LTS 18.x

* update nginx image CVE-2022-43551

* upgrade node version in GH workflows

* update nodejs version in dev docs

* upgrade tldraw version nodejs version to 18.x

* update static/yarn.lock

* fix yarn.lock electron version

---------

Co-authored-by: situ2001 <yongcong2001@outlook.com>
2023-02-21 23:07:35 +08:00
Junyi Du
d6531780d6 Update VSCode + Calva with more details 2023-02-14 23:36:31 +08:00
Kidy Lee
05f9748590 add repl setup to development document 2023-02-14 23:36:31 +08:00
Gabriel Horner
c4d15ec848 Document dev commands and dev tools 2023-02-03 10:58:24 -05:00
Phoenix Eliot
f0744e32c5 Fix arch/sudo command in instructions
This command runs properly on my M1; the one listed before gives the error `arch: posix_spawnp: gem: Bad CPU type in executable`
2023-01-31 15:50:29 -05:00
Gabriel Horner
d58a2a95dc Make optional fns section more readable 2023-01-20 17:28:55 -05:00
Gabriel Horner
0d60dfd953 Make first bb cmd more readable per Bad3r. Close #8394 2023-01-20 17:15:28 -05:00
Gabriel Horner
2a56dc133e Add a section for fn instrumentation and make test section less confusing
Follow up to #8265
2023-01-13 14:36:18 -05:00
Junyi Du
7790c791fa chore: update dev-practices for E2E dump 2023-01-13 22:25:10 +08:00
Bad3r
d8303d055c docs(dev): maintain style 2023-01-12 18:28:53 +08:00
Bad3r
55971f085b docs(dev): update linting to match bb dev:lint
update to match `$ bb dev:lint`
```cljs
(defn lint
  "Run all lint tasks
  - clj-kondo lint
  - carve lint for unused vars
  - lint for vars that are too large
  - lint invalid translation entries"
  []
  (doseq [cmd ["clojure -M:clj-kondo --parallel --lint src --cache false"
               "bb lint:carve"
               "bb lint:large-vars"
               "bb lang:invalid-translations"
               "bb lint:ns-docstrings"]]
    (println cmd)
    (shell cmd)))
```

not sure if we should just add `$ bb dev:lint` since it doesn't seem to be documented anywhere

this update is a pre-req to adding docs for data validation with Malli from https://github.com/logseq/logseq/blob/dev/malli-schema%2526kondo-config/

```sh
bb dev:gen-malli-kondo-config
```

Note that it will also need to be added to `build.yaml`
https://github.com/logseq/logseq/blob/dev/malli-schema%26kondo-config/.github/workflows/build.yml

CC: @RCmerci
2023-01-12 18:28:53 +08:00
Junyi Du
cfce689632 chore: upgrade dev-practivce on upgrading electron 2023-01-12 17:26:42 +08:00
Bad3r
a2bb85331e fix: do not link to a specific cljfmt version docs
the link https://cljdoc.org/d/cljfmt/ will always load the most up to date documentation of cljfmt. 
It should be used instead of a specific version number
2023-01-04 12:53:41 -05:00
Gabriel Horner
4eec463cbb Tweaks to PR
- Move auto-formatting down as it's not as important as other sections
- Reword to have focus be on auto-formatting and less so on cljfmt
2023-01-04 12:38:40 -05:00
Phoenix Eliot
133028c043 Update per CR feedback 2023-01-04 12:37:27 -05:00
Phoenix Eliot
83a7beea3a Add note about auto-formatting 2023-01-04 12:37:27 -05:00
Bad3r
1444d2600f enhance(docs): add a table containing all current lables and their descriptions 2023-01-04 13:57:59 +08:00
Junyi Du
f45317e569 chore: query performance: enlarge test timeout and add dev doc 2022-12-15 20:37:17 +08:00
Gabriel Horner
effaf0f741 Doc e2e debugging workflow available with #7505 2022-11-30 14:42:39 -05:00
Junyi Du
14ee3d0cca Update e2e practices 2022-11-24 20:17:59 +08:00
Gabriel Horner
e7e49f2ff3 Clarify when to run static install for #7255 2022-11-15 14:25:24 -05:00
Matt Lilley
03afc9023b Fixes documentation for browser development.
Released files are placed in static/ rather than resources/
2022-11-14 16:43:04 +08:00
Junyi Du
d40bfa2fbe Update develop-logseq-on-mobile.md 2022-11-08 16:22:13 +08:00
kv-gits
4682274e10 Update develop-logseq-on-windows.md
JRE x64
2022-11-04 23:17:51 +08:00
Gabriel Horner
2685cd1325 Fix bug with certain plugins and misc cleanup
- Plugins that used effects weren't loading correctly e.g.
  logseq-power-plugin
- Cleaned up translation, docs and some fn naming
2022-10-17 10:31:07 -04:00
Gabriel Horner
784ad7cce3 Add unit tests for create-if-not-exists and misc test improvements
- Added unit test as it is used by several handlers
- Fixed test suite failing from last commit now that a test fs is used
- Fixed test stat implementation
- Extracted out Plugin schema to make usage of it less impl dependent
- Made test.helper alias consistent
- Made async testing consistent for export-test
2022-10-17 10:13:27 -04:00
Gabriel Horner
c8cda90373 Fix plugin install bugs and add plugin-config tests
- Add validation for plugins.edn with malli
- Add bb task using malli schema
- Add first async test that interacts with frontend.fs
- Add test helpers to make future async testing easier
2022-10-17 10:13:27 -04:00
Gabriel Horner
1f0e22275d Add ns docstrings for most ns in src/main
- Added to CI now that it passes
- Added no-doc for docstrings that don't add any more than what's in the
ns name or for ones where I didn't know the ns that well
2022-09-27 13:55:16 +08:00
Gabriel Horner
a368cab5e4 Add ns linter to deps libs and then add+update ns docstrings 2022-09-21 10:17:15 +08:00