Skip to content

Bs26 bib intake instructions#342

Open
stumbo wants to merge 7 commits into
mainfrom
bs26_bib_intake_instructions
Open

Bs26 bib intake instructions#342
stumbo wants to merge 7 commits into
mainfrom
bs26_bib_intake_instructions

Conversation

@stumbo

@stumbo stumbo commented Jul 16, 2026

Copy link
Copy Markdown
Member

Add the Interlisp Bibliography Intake Document to the website as a markdown file.

The document can be found via a reference at the top of the bibliography index page. We currently have a line of text stating the bibliography is created from Zotero. Another line of text has been added stating that information on adding a new entries can be found at and referencing the intake document.

The intake document resides in the bibliography subdirectory content/en/history/bibliography/intake

Additional changes were made to the github actions that drive creating the complete bibliography index. The hashing scheme needed to be updated to capture changes to the bibliography directory and not just the Zotero dataset.

The updated index page with link to the intake guide is currently running on the staging site.


As discussed in the 2026-07-15 Interlisp external meeting, I used the formal intake guide and not the quickie guide. Suggestions on changing the content are welcome. My quick scan of the quickie guide leaves me to believe that this one is more appropriate because it actually references the Google Form for suggesting new entries.

stumbo added 3 commits July 15, 2026 07:29
Guide is a subpage of the bibliography page.
Currently we only use the Zotero version as a cache key and we
cache both the generated Zotero bibliography entries along with
the human generated files.  The change to _index.md and future
changes to the intake md files would never be recognized.  Changes
would only be propogated when Zotero was updated.

The updated key looks for both changes to Zotero and the bibliography
directory.
@stumbo stumbo self-assigned this Jul 16, 2026
@pamoroso

Copy link
Copy Markdown
Member

On rereading the quickie intake guide I think the formal guide is more appropriate.

@masinter

Copy link
Copy Markdown
Member

@mhafizazh look at this

@pamoroso

Copy link
Copy Markdown
Member

@hjellinek and @Eleanor-Young may also want to have a look at this.

@hjellinek

Copy link
Copy Markdown
Contributor

"Information on submitting new entries can be found at Interlisp Bibliography Submission"

Please change this to:

"The Interlisp Bibliography Intake Guide explains how to recommend new bibliography items."

and link the second through fifth words to the page of that name. Don't forget the period at the end of the sentence.

@stumbo
stumbo force-pushed the bs26_bib_intake_instructions branch from 2569d09 to d0af40e Compare July 17, 2026 11:05
@stumbo

stumbo commented Jul 17, 2026

Copy link
Copy Markdown
Member Author

"Information on submitting new entries can be found at Interlisp Bibliography Submission"

Please change this to:

"The Interlisp Bibliography Intake Guide explains how to recommend new bibliography items."

and link the second through fifth words to the page of that name. Don't forget the period at the end of the sentence.

It took butterfingers a couple tries to get it typed correctly, but we managed to untangle my fingers long enough. Thanks for improving the sentence.

@pamoroso

Copy link
Copy Markdown
Member

At commit d0af40e, at the History page of the staging site the Bibliography entry is missing altogether from the left sidebar.

@stumbo

stumbo commented Jul 20, 2026

Copy link
Copy Markdown
Member Author

At commit d0af40e, at the History page of the staging site the Bibliography entry is missing altogether from the left sidebar.

This is fixed by removing the toc_hide entry I had added to _index.md. A misguided attempt to clean up a warning message.

@stumbo

stumbo commented Jul 20, 2026

Copy link
Copy Markdown
Member Author

Two questions to consider:

  • Do we want the Intake guide within the Bibliography directory? This is the current arrangement. The benefit is that all bibliography content is wrapped within a single directory. The minus is that we have a directory that is a mix of bibliographic entries and (currently) one document describing how to maintain the bibliography. To a large degree it is lost in there.
  • Secondly, the left pane lists various documents within the website, in this particular case the History pages. Docsy defaults to showing just 100 entries per subdirectory. Currently our bibliography has over 400 entries.
    • Do we want all the entries displayed in the left pane?
    • Should the displayed entries be ordered alphabetically by title?
    • Should entries be just documents and not bibliography entries? If so, the only subelement would be the intake guide.

We should address the location of the intake guide as part of this PR, the other issue on what goes in the left pane can be handled in a separate PR.

@pamoroso

Copy link
Copy Markdown
Member

I think the Bibliography directory is fine for the intake guide, and it would be better not to display the bibliography entries in the left pane. It's useful to discusse these issues in the next external meeting of July 22.

After commit 63ea761 the Bibliography is still missing from the staging site.

@Eleanor-Young

Copy link
Copy Markdown

I think ideally it would be best to have the intake guide not in the same directory as actual bibliography items, but it's not anything catastrophic, of course. Depending on whether we think it would be making things too messy, having it somewhere still under bibliography, but not in the same chain of directories as the items themselves would be nice. Something like bibliography/intake for the guide, then bibliography/items for the items themselves, for instance, if that wouldn't break too many things (or, if it does, if those things wouldn't be too hard to un-break).

@stumbo

stumbo commented Jul 24, 2026

Copy link
Copy Markdown
Member Author

The latest updates are available on the staging site

Based on Wednesday's conversation in Interlisp External meeting, I set bibliographical entries not to show in the left pane.

I have not implemented expanding the left pane sub-menu - it currently shows bibliography with the triangle next to it, signaling there are sub-entries. This is what we have set as the default behavior for all sub-menus on the site. Changing the behavior for one sub-menu would require customizing the left pane handling. I'd prefer not to do that. Other options are to set all sub-menus to expand -- there is a flag we can use in conjunction with this setting to limit the depth for sub-menu expansion. However, our site is more broad then deep, so I don't see this giving us a lot of benefit.

Before I proceed:

  • Is the current behavior of sub-menus acceptable?

  • Also, I believe the final decision in our meeting [Where is the fathom recording when you need it?] was to leave the bibliographic entries and intake document in this directory. Given we're no longer showing the bibliographic entries in the left pane we were comfortable with having the Intake Document in there. It will show up in the left pane as the only document. You can observe this behavior on the staging site.

    We discussed putting the Intake Document in a separate location either as a sub-directory or in another part of the website, in the end we determined that the added indirection had little benefit.

@pamoroso

Copy link
Copy Markdown
Member

At commit 5abbeb4 the behavior of the sub-menus looks good and I'm okay with leaving the intake guide in the bibliography directory.

@hjellinek

Copy link
Copy Markdown
Contributor

It's unlikely that anyone will ever see the link to the intake guide in the left column of the history/ page. That little expando-triangle doesn't suggest why you'd care to click it.

That said, the Bibliography item's link takes you to history/bibliography/, which has a link to the intake guide anyway. But we can improve it! I suggest changing this

The [Interlisp Bibliography Intake Guide](https://stumbo.github.io/InterlispDraft.github.io/history/bibliography/intake/) explains how to recommend new bibliography items.
We generate this from our [Zotero collection library](https://www.zotero.org/groups/2914042/interlisp/library).

To

We generate this from our [Zotero collection library](https://www.zotero.org/groups/2914042/interlisp/library).

The [Interlisp Bibliography Intake Guide](https://stumbo.github.io/InterlispDraft.github.io/history/bibliography/intake/) explains how to recommend new bibliography items.

Note the blank line between the two sentences, which helps increase the prominence of the second one.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants