Documentation overhaul #266
Merged
Conversation
This file contains 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
This was referenced Sep 11, 2022
Merged
ribosomerocker
force-pushed
the
doc-branch
branch
from
cbc0d14
to
984b9d9
Compare
thiagokokada
approved these changes
Sep 12, 2022
ckiee
requested changes
Sep 13, 2022
ckiee
requested changes
Sep 21, 2022
|
|
||
| If you encounter any issues while using nix-doom-emacs, you can find some of us in the [Matrix room](https://matrix.to/#/#doom-emacs:nixos.org). Only bugs should be filed in our [issue tracker](https://github.com/nix-community/nix-doom-emacs/issues). | ||
|
|
||
| nix-doom-emacs uses [`nix-straight.el`](https://github.com/nix-community/nix-straight.el) under the hood to install dependencies. It's a low level wrapper to integrate Nix with [`straight.el`](https://github.com/radian-software/straight.el). It is maintained by the same people as this project. |
There was a problem hiding this comment.
This is dev/contributing docs. Bad place.
| Ordered from most suggested to least suggested. | ||
| In all of these methods, you'll need your Doom Emacs configuration. It should contain the following three files: | ||
| `config.el`, `init.el` and `packages.el`. If you don't already have an existing `doom-emacs` configuration, you can use the contents of `test/doom.d` as a template. | ||
|
|
There was a problem hiding this comment.
Unreviewed after here since I'd like to see how things look moved around first.
ckiee
reviewed
Sep 24, 2022
ghost
reviewed
Nov 12, 2022
ghost
reviewed
Nov 12, 2022
YellowOnion
reviewed
Dec 1, 2022
docs/reference.md
Outdated
| programs.doom-emacs = { | ||
| enable = true; | ||
| doomPrivateDir = ./doom.d; | ||
| emacsPackage = pkgs.emacsPgtkNativeComp; |
There was a problem hiding this comment.
error: anonymous function at /nix/store/1q10ylzzjmxwz5a4zy3dbdd9dzw8n0l6-source/default.nix:1:1 called with unexpected argument 'emacsPackage'
at /nix/store/4idp9fvcbrp511x4vykas35yiiaqfbw6-nixos/nixos/lib/customisation.nix:72:16:
71| let
72| result = f origArgs;
| ^
73|
Did you mean emacsPackages?
(use '--show-trace' to show detailed location information)
There was a problem hiding this comment.
With some more digging, it's not obvious how to compose emacs-overlay with the non-flake home manager, since one uses home.packages, and the other uses the module enable method.
thiagokokada
force-pushed
the
doc-branch
branch
from
27878c9
to
3067a7a
Compare
ckiee
approved these changes
Jan 17, 2023
|
Nice. Sorry for not having the time to work on this, thank you for merging. I'll be deleting this branch. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This makes a few assumptions about what will happen to the future of nix-doom-emacs. It expects 1. the
packagesattribute to exist in the flake 2. for it to be an attribute set, not a function 3. that it has adefaultattribute and anix-doom-emacsattribute. 4. that they're overridable with module settingsFor that reason, this is a draft. I will unmark it as a draft once all of the changes have been made.