Where shall I keep my Engineering Notebook?

[edreamleo]

Over the years I have made dozens (hundreds?) of ENB (Engineering Notebook) entries in Leo's forum. These ENBs are a permanent, public part of the Leonine world. ENBs have recorded the evolution of many breakthroughs in Leo's design and code. ENBs have often been pre-writing for documentation.

As discussed previously, I have just become aware of the depth of my ignorance concerning what Rope does and how it works :-) A series of ENBs seems inevitable.

But where to put these ENBs?

• ekr-study-rope's discussions won't be permanent.
• My personal blog won't do: I want GitHub's fonts, etc.

@lieryan Would it be alright with you for me to create ENBs here? There might be many of them.

[edreamleo]

I've just discovered Using Rope As A Library. Yes, that page will be a useful overview. Otoh, I am mostly interested in understanding exactly how soi works.

[lieryan]

Rope currently has two documentations.

The first one is the one you've discovered, in the /docs folder in the source code is the oldest and rope's primary documentation. It's automatically published to RTD
with every change to master.

The second one is the Github Wiki, which is basically just a Markdown repository (you can git clone it to grab a copy for local editing). This is where I've been putting new docs and notes that doesn't really fit the existing /docs folder, it's a bit of a distance away from the codebase as there are sometimes things it contains that are only somewhat related to rope.

Finally, there's also a cache of hidden third "documentation" in the git history. This is mostly the implementation notes by the guy who originally wrote rope. They often contain numerous insights of what he was thinking when he developed a feature. Problem is that they're kinda scattered, since he had a habit of deleting the notes from the codebase once he's done implementing a feature and he no longer need those notes himself, so there's no single checkout that contained all those notes.

[edreamleo]

@lieryan Thanks for the links. The Wiki seems good to me.

Do you know the github name of the person who wrote the hidden notes? If so, git should be able to filter their commits.

[lieryan]

aligrudi is the original author of Rope.

[edreamleo]

Thanks. I'll look through the history to see if I can create an index of aligrudi's comments.

[edreamleo]

@lieryan A quick look at git log --author=aligrudi doesn't reveal much. I'll try other ways of studying the code.