search

thousandbrainsproject / tbp.monty

Monty is a sensorimotor learning framework based on the thousand brains theory of the neocortex.
https://thousandbrainsproject.readme.io
MIT License
107 stars 27 forks source link

Updating readme.md link for Application Criteria & Current Capabilities #51

Closed OcWebb closed 22 hours ago

OcWebb commented 1 day ago

Straightforward link update. I do hope to contribute more meaningfully in the future.

OcWebb commented 23 hours ago

Thank you for linking that prior PR, based on that it seems the desire was to go with the shorter slug. In that case, I could update my pull request later. I suspect the title metadata field is used as the default slug when not otherwise defined, but this document indicates we could add a slug field to the metadata. Either solution may work.

codeallthethingz commented 23 hours ago

Yes, because readme.com's create-doc API is a bit strange. When you create a doc you can only use the title in the create request and readme.com tells you the slug that was created. When you're running a sync, the tool uses the slugs in the hierarchy.md to check if there is an existing page and update it, if it doesn't find the slug, it creates a new page based on the title.

This shouldn't happen too often because we're not changing slugs now we're live. I did a test in this PR #54

vkakerbeck commented 22 hours ago

Thanks for the explanation @codeallthethingz Does that mean to change a slug I just need to change the metadata at the top of the page? @OcWebb yes, exactly, that was my original intent to use the shorter title and slug. Thanks for offering to update the PR. I think for practical reasons (since we are still waiting on your CLA to be processed) I would merge Will's PR with the slug fix. I really appreciate you finding this error and also offering a fix for it so quickly!

codeallthethingz commented 22 hours ago

@vkakerbeck Correct. To change a slug you need to change the metadata title in the document, the slug in the hierarchy.md and all the references to the old slug.

OcWebb commented 22 hours ago

It makes sense to clean this up quickly with the other PR. Thanks for all the responses. I do intend to parse through the codebase and hope to contribute something more substantial in the future. Very excited for this project!

I will close this PR.

vkakerbeck commented 21 hours ago

thanks for understanding! I didn't want to dampen your enthusiasm by not merging this PR. Definitely looking forward to hearing more from you :)