-
-
Notifications
You must be signed in to change notification settings - Fork 156
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Documentation for lem #1226
Comments
Hi, thanks for bringing a workforce to this task.
IMO you cant start right away by writing content to Lem's website. There is a first overview of displaying concepts: https://lem-project.github.io/development/displaying/ and a short tutorial on how to write a major or minor mode: https://lem-project.github.io/usage/extension_modes/ When we wrote this we were like you, discovering Lem on the go while working on a feature and exploring its codebase.
Lem is an Emacs-like editor, so that's a first hint… but Lem doesn't copy Emacs either, that is very clear by Lem's creator : ) There is no mailing list but the Discord. IMO a good place to ask for high-level explanations is Github discussions and Discord.
What do you want to do, is writing on the website enough? There could be the goal of generating a documentation for Lem's internals, but I think hand-written tutorials are our first need. Though we could leverage a tool that allows to reference built-in functions and display its documentation. Such a tool could be codex, sphinx-contrib and maybe more… (see awesome-cl). |
In order to facilitate my understanding, and ease onboarding of others in the future, I'd like to document the architecture of lem and the various components in this repository.
I'm looking for the following information:
The text was updated successfully, but these errors were encountered: