A magical documentation site generator. Simple and lightweightNo statically built html filesMultiple themes

International Conference on Indigenous Language Documentation, Education and Revitalization (ICILDER) last weekend at the University of Indiana.

If there’s only an asterisk: Click the style name, then move the pointer over the style name in the Paragraph Styles pop-up menu. Click the arrow that appears, then choose Redefine from Selection.

Tell future-you why you did that thing; they can read but don't know what you intended. Oral tradition is like never writing state to disk; flush those buffers.

A documentation-first culture does not mean everyone is busy writing documents all day. It means that everyone appreciates the value of documenting and sharing their experiences.

I’m a big fan of documentation. I think it’s my favorite boring thing to do after coding. It brings the business so much long-term value that every hour invested into documentation by anyone saves literally x100 productivity hours across the company.

Available as a monolithic file, by chapters, and in PDF — git repository.

Mona also makes good use of the iPad’s support for keyboard shortcuts.

Raindrop also has an excellent browser extension that allows you to save a webpage to any of your link collections, tag it, mark it as a favorite, access highlights, set reminders, and even save multiple tabs simultaneously.

You can also send it to another person to share it with them.

Web Monetization

It would probably be worth mentioning this explicitly in the README: "Configuration of the language server happens over the LSP protocol by passing a configuration object; your LSP client should have a way of setting the configuration object for a server. Here is a link to the spec for the configuration that is supported [...]"

And with diagrams as text close to the code chances are they will be kept to up to date (and created to begin with…).

It is handy to manually generate the diagram from times to times using the previously created command: npm run db:diagram:generate. Though, getting the diagram to update itself on its own automatically without a developer interaction would ensure that it the diagram is never obsolete. There are several ways of doing this.You could use a pre-commit git hook or even better simply configure your CI/CD pipeline(s) to run the npm script whenever something gets merged into the main branch 🙂

When it comes to showing up somewhere in your documentation a diagram describing your SQL database, you often end up with a recurring problem : after a few days / weeks / months, the diagram you made became obsolete.

the functional core, imperative shell pattern

For new code, it’s usually a good idea to design the code so that it’s easy to test with “real” objects, rather than stubs or mocks.

We keep our functional tests separate from our unit tests, in the tests/functional directory. Because these are slow to run, we will usually write one or two functional tests to check a new feature works in the common case, and unit tests for all the other cases.

To run the backend test suite only call tox directly

will improve collaboration

information

Our most current documentation to get started with Aruba as a user can be found in ./features/.

Impact Object – The Impact Object collision data will be sent to. If empty, it will attempt to find an Impact Object on the collider that was hit or one of its parents.

Impact Triggers are components that tell Impact Objects when to play interactions and with what data. They are the origin that provides the data which is sent to the object’s Impact Material to ultimately play the interactions defined on the material.

Impact Object Rigidbody uses FixedUpdate to ensure accurate interactions, especially when sliding and rolling. However, this can cause overhead if there are a lot of objects.

Any Impact Triggers must be on the root of the object (the same object as the Rigidbody), and should have their Impact Object field empty. Impact Triggers must be on the same component as the Rigidbody,

Impact Object Single Material is the simplest type of Impact Object, with a single material used for the object. It is most suited for static objects and level geometry. You can add this script to your objects by going to

Priority can be used to ensure that certain objects will always play their interactions, even if it requires "stealing" resources that are already in use.

Impact Objects are components that you attach to the objects in your game’s world to specify their material, so that other objects (and other parts of your game) know how to interact with them. Impact Objects can also provide physics data such as rigidbody velocity.

The Audio Source Template prefab must have an Impact Audio Source component attached to it.

Pool Size – The size of the object pool created for this audio source.

Impact Materials define what interactions will occur when an object interacts with the tags defined in the Impact Tag Library

The size of this buffer limits the number of interaction results that can be returned by a single interaction, so make sure this is set appropriately for how many interaction results your materials can return.

This is a hard limit that will be checked as soon as a collision message is recieved. If the limit has been reached for that fixed update frame, processing will be aborted immediately. Typically you would want to set this to be about the same size as your object pools. Triggers can be set as High Priority to ignore this limit.

Material Mapping works best for static, single material objects. Without an Impact Object component attached, no material composition or velocity data can be obtained

Material Mapping allows you to map Unity's Physics Materials to Impact Materials. This is useful so that you don't necessarily have to add an Impact Object component to all of the objects in your scene.

For example, if you have a terrain you will probably want to set this to the number of textures your terrain uses.

The first field is an Impact Tag Library which is used to display a user-friendly dropdown for the tag or tag mask. The second field represents the actual value of the tag or tag Mask

Just remember that under the hood tags are represented only by integers, so using multiple tag libraries with different tag names does not mean you can have more than 32 tags.

Rules formulated with openVALIDATION are thus at the same time a formal, machine-processable specification, but also a documentation that is easy for people to understand.

Code explains what and how Documentation explains why.

So make sure to write your documentation, but do not explain your spells.

Do you really need those lines? Isn’t it clear enough? Well, I still find comments like this in a lot of cases and it gets funnier when the comment is obsolete and the code is doing other things. Following the example, let’s imagine that another developer adds support for PUT method. I think that this is what would happen.

That’s why it was such a life-changing event for me when I found Dash in 2012.

To be fair, for a $30 asset I don't really expect that much support, but the problem here is that because of the lack of docs and hard to parse and modify codebase, folks are way more dependent on the developer than for other assets with proper docs, field tooltips, and maintainable code.

Diagramming and documentation costs precious developer time and gets outdated quickly. But not having diagrams or docs ruins productivity and hurts organizational learning. Mermaid addresses this problem by enabling users to create easily modifiable diagrams, it can also be made part of production scripts (and other pieces of code).

try to provide duplicate overlapping examples.

Thus my docs recommendation of public function beforeFilter(Event $event) // do not render out the now inconsistent one for is(json) if (!$this->request->is('jsonapi')) { throw new NotFoundException('Invalid access, use application/vnd.api+json for Content-Type and Accept.'); } } to specifically only whitelist the desired jsonapi for the general use case.

// NB: Since line terminators can be the multibyte CRLF sequence, care // must be taken to ensure we work for calls where `tokenPosition` is some // start minus 1, where that "start" is some line start itself.

getLineStart(tokenPosition, anteTerminators = null) {
  if (tokenPosition > this._edge && tokenPosition != this.length) {
    throw new Error("random access too far out"); // XXX
  }

  // NB: Since line terminators can be the multibyte CRLF sequence, care
  // must be taken to ensure we work for calls where `tokenPosition` is some
  // start minus 1, where that "start" is some line start itself.
  for (let i = this._lineTerminators.length - 1; i >= 0; --i) {
    let current = this._lineTerminators[i];
    if (tokenPosition >= current.position + current.content.length) {
      if (anteTerminators) {
        anteTerminators.push(...this._lineTerminators.slice(0, i));
      }
      return current.position + current.content.length;
    }
  }

  return 0;
}

No additional considerations for iOS, macOS, or tvOS.

Good documentation includes background and decision information that cannot be derived from the code.

I wish education was based around this principle.

Don’t be the project people leave. Be the project people turn to.

In addition to the daily limits, there are follow ratios that go into effect once you’re following a certain number of accounts:Every Twitter account can follow up to 5,000 accounts. Once you reach that number, you may need to wait until your account has more followers before you can follow additional accounts. This number is different for each account and is automatically calculated based on your unique ratio of followers to following.

I hope you'll forgive me for defaulting to the documentation: I think it will do a better job of explaining it than me.

the interesting thing here is that there are comments that say which concern depends on which.

I have made some discoveries in London about my uncle Herncastle and his Diamond, which have rather an ugly look to my eyes; and I want you to confirm them.

This prefatory narrative I have already got by me in the form of an old family paper, which relates the necessary particulars on the authority of an eye-witness

Most of the matchers provided by this gem are useful in a Rails context, and as such, can be used for different parts of a Rails app: database models backed by ActiveRecord non-database models, form objects, etc. backed by ActiveModel controllers routes (RSpec only) Rails-specific features like delegate

So that was our rainbow child, Eli, and that's when I started going downhill, because my stuff got denied. I didn't have the privileges that every normal US citizen gets to have. So I had two kids, no way to provide for them.

No, they haven't reached an agreement, but it's this new dream. If you had known that all you had to do was keep going to school and you could get a social security card and you could have a path to citizenship, would that have made a difference, do you think?

We didn't have papers. On top of that, we're not from there. So we don't have papers. Not papers, but you know how you have to get the medical shots. We had to redo all of that stuff. So my mom got the shots, did all the immunization records and all that stuff.

I noticed all my friends getting jobs and having new shoes and this and that. And I would ask him like, "What are you doing?" And he was like, "I just got a job. I got a car. I got this."Mike: I could see them--that they were advancing in life, and I was still in the same spot. So I asked my mom if I could get a job, and that's when she broke it down to me that I wasn't even from here. And that was right there like a slap in the face.

Luisa: I was set to go into a good future. That's what it was, but when it came down to it, my mom was like, "No. You know what? You can't. You don't have papers. You can't continue your education here. We cannot afford to pay your entire tuition. We cannot afford to pay for your housing or your books. Each book, that's like $5000 for books. We can't do that. I'm sorry."

The first time was when I wanted to apply to Whitney Young—when I wanted to go to a different high school. I had the grades for it [Chuckles]. I've always had the grades for it, but they were asking … I don't remember what kind of document they were asking for that scared me into not applying, and I was like, "You know what? Let’s not. I don't want to. It's not worth it if I get deported. I don't need to be—it's not necessary." So I went to my local high school, which … not the best high school, Washington High School, but they had the IB program.

Yes. There came a point. We were in the [Pause] process of getting our permanent residency card in order to be able to go to school, and the lawyer let my mother know that me and my sister—my other sister—were not going to make it because once you hit eighteen, you're no longer under the case that you originally filed, so the best option for us would be adoption. We would be adopted by an American citizen in order to get our American status fixed, and that was something my mom and I contemplated for a long, long time, and she was going to go through with it, but my dad put a huge stop to that and was like, "That's not happening. You're stupid. That's not a thing. These are my kids. You're not letting that happen."

A cookie is associated with a domain. If this domain is the same as the domain of the page you are on, the cookie is called a first-party cookie. If the domain is different, it is a third-party cookie. While the server hosting a web page sets first-party cookies, the page may contain images or other components stored on servers in other domains (for example, ad banners), which may set third-party cookies. These are mainly used for advertising and tracking across the web.

Javascript

Javascript

```go package main import “fmt” func main() { fmt.Println(“Hello, world”) }

```go

–

Be as specific or vague as you'd like – it is your blog

one more

-g

install LESS compiler

I'm maintaining one that can be run and asserted on: https://github.com/cirosantilli/rails-cheat/blob/master/app/test/integration/capybara_test.rb

The urgent argument for turning any company into a software company is the growing availability of data, both inside and outside the enterprise. Specifically, the implications of so-called “big data”—the aggregation and analysis of massive data sets, especially mobile

Third configurable block to run.

Sprockets 4: The effect of config.assets.debug does not match the rails documentation.

This appears to be an undocumented breaking change. For example, the word "debug" does not appear in the sprockets 4 changelog.

Should it only contain link* calls?

The docs say: "When using Rails and Sprockets in development mode, no assets are concatenated."

demonstrate

we have a helpful little framework behind the page rendering that pulls code snippets from real tests out of the actual gems

Writing documentation for the new website has been fun. Yes, fun!

We have fully documented the migration path to 2.1 while upgrading several complex apps. It worked.

Advanced features like tracing, input/output filters or type checking leverage the framework argument flow_options

What this means is: I better refrain from writing a new book and we rather focus on more and better docs.

We try to keep the “information architecture” - a word I wouldn’t have learned without the inspiring Alex Coles - as simple as possible: so far, we got a handful of pages accessible through the top navigation, and then the documentation behind the DOCS link. Here, the right sidebar helps you to navigate within the chapter.

Use the desc option to provide human-readable descriptions of filters. You should prefer these to comments because they can be used to generate documentation.

NIX_PATHA colon-separated list of directories used to look up Nix expressions enclosed in angle brackets (i.e., <path>). For instance, the value

0 [14:16:19] nix repl
Welcome to Nix version 2.3.10. Type :? for help.

nix-repl> :l <nixpkgs/doc>  
Added 40 variables.

nix-repl> :l <doc>
error: file 'doc' was not found in the Nix search path (add it using $NIX_PATH or -I)

$ echo $NIX_PATH
nixpkgs=/nix/var/nix/profiles/per-user/root/channels/nixos:nixos-config=/etc/nixos/configuration.nix:/nix/var/nix/profiles/per-user/root

$ export NIX_PATH=/home/toraritte:/nix/var/nix/profiles/per-user/root/channels/nixos

$ printenv NIX_PATH
/home/toraritte:/nix/var/nix/profiles/per-user/root/channels/nixos

$ nix repl
Welcome to Nix version 2.3.10. Type :? for help.

nix-repl> :l <nixpkgs>
Added 12439 variables.

1-650-649-1942

estateclaims@my.usdirectexpress.com

1-650-649-1942

docs@my.usdirectexpress.com

every document could disappear 6 months after it's published unless whoever uploaded or created it says otherwise in an email the system sends them after six months, documents shouldn't live rent free

Reload the systemd manager configuration. This will rerun all generators (see systemd.generator(7)), reload all unit files, and recreate the entire dependency tree. While the daemon is being reloaded, all sockets systemd listens on behalf of user configuration will stay accessible.

we do need to have this somewhere

I'm afraid there's only so much the docs & tutorials can do about something like this actually. When you first read them, you don't get Svelte well enough (since you're reading a tutorial...) for this to make sense to you. Then you try something, encounter a behaviour, question it, understand better... That's learning.

Anyway, If this is an expected behaviour, we should probably add an asterisk to the docs, describing the pitfall, because I believe many will be bitten by this.

Would you mind adding it to the vendor README.md with a note to this commit so we remember?