# Documentation for xBlock Asides?

**URL:** <https://discuss.openedx.org/t/documentation-for-xblock-asides/12433>\
**Category:** Development\
**Created:** [March 4, 2024, 1:10am UTC](https://discuss.openedx.org/t/documentation-for-xblock-asides/12433 "2024-03-04T01:10:17Z")\
**Posts on this page:** 9\
**Page:** 1

<div class="post-metadata">

**Author:** ![pdpinch](https://sea2.discourse-cdn.com/flex020/user_avatar/discuss.openedx.org/pdpinch/32/36_2.png) [@pdpinch](https://discuss.openedx.org/u/pdpinch)\
**Post date:** [March 4, 2024, 1:10am UTC](https://discuss.openedx.org/t/documentation-for-xblock-asides/12433/1 "2024-03-04T01:10:17Z")

</div>

I’m trying to find documentation for the xBlockAsides feature initially described in this [google doc](https://docs.google.com/document/d/15vv-pM-6Q39rnqhNFBHQTpUJaAk5Labthk_vczfjOKM/edit?pli=1#heading=h.t8qnb8qntvjh) and implemented in [the sample “Thumbs” xBlock in the xBlock SDK](https://github.com/openedx/xblock-sdk/tree/master/sample_xblocks/thumbs).

MIT Open Learning has been using this extension point for some time now in its [Rapid Response xBlock](https://github.com/mitodl/rapid-response-xblock/), but the UI doesn’t work in the Course Authoring MFE. We’ve [opened a PR to address this](https://github.com/openedx/frontend-lib-content-components/pull/452), and it would be helpful to have some documentation to explain the context for product review and code review.

If there is no documentation, we can write some, although I need guidance on where such documentation belongs.

Peter Pinch  
MIT Open Learning

---

<div class="post-metadata">

**Author:** ![feanil](https://sea2.discourse-cdn.com/flex020/user_avatar/discuss.openedx.org/feanil/32/37_2.png) [@feanil](https://discuss.openedx.org/u/feanil)\
**Post date:** [March 4, 2024, 5:02pm UTC](https://discuss.openedx.org/t/documentation-for-xblock-asides/12433/2 "2024-03-04T17:02:17Z")

</div>

I was hoping that there would be something [XBlock Concepts — XBlock API Guide documentation](https://docs.openedx.org/projects/xblock/en/latest/xblock-tutorial/concepts/index.html) but there is nothing. @dave, @kmccormick or @braden any of you aware of any good docs for asides that might be elsewhere?

---

<div class="post-metadata">

**Author:** ![kmccormick](https://sea2.discourse-cdn.com/flex020/user_avatar/discuss.openedx.org/kmccormick/32/8982_2.png) [@kmccormick](https://discuss.openedx.org/u/kmccormick)\
**Post date:** [March 4, 2024, 5:15pm UTC](https://discuss.openedx.org/t/documentation-for-xblock-asides/12433/3 "2024-03-04T17:15:57Z")

</div>

I have [a PR open](https://github.com/openedx/XBlock/pull/718) that would add some [rudimentary reference documentation](https://docsopenedxorg--718.org.readthedocs.build/projects/xblock/en/718/xblock.html#xblock.core.XBlockAside).

Other than that, I am not aware of any Aside docs.

---

<div class="post-metadata">

**Author:** ![braden](https://sea2.discourse-cdn.com/flex020/user_avatar/discuss.openedx.org/braden/32/46_2.png) [@braden](https://discuss.openedx.org/u/braden)\
**Post date:** [March 4, 2024, 7:06pm UTC](https://discuss.openedx.org/t/documentation-for-xblock-asides/12433/4 "2024-03-04T19:06:39Z")

</div>

I’m not aware of any documentation. I didn’t even think the feature was fully implemented tbh.

Alongside documentation, if this is a feature we intend to support in the future, it would be great to have examples of asides in the sample course for authors and the devstack default course(s), to raise awareness and facilitate easier regression testing.

---

<div class="post-metadata">

**Author:** ![ashultz](https://sea2.discourse-cdn.com/flex020/user_avatar/discuss.openedx.org/ashultz/32/3371_2.png) [@ashultz](https://discuss.openedx.org/u/ashultz)\
**Post date:** [March 5, 2024, 2:05pm UTC](https://discuss.openedx.org/t/documentation-for-xblock-asides/12433/5 "2024-03-05T14:05:04Z")

</div>

Asides were fully implemented, but the implementation on the studio side predates a lot of changes and certainly predates the MFEs. They basically do not work at all in studio.

---

<div class="post-metadata">

**Author:** ![pdpinch](https://sea2.discourse-cdn.com/flex020/user_avatar/discuss.openedx.org/pdpinch/32/36_2.png) [@pdpinch](https://discuss.openedx.org/u/pdpinch)\
**Post date:** [March 6, 2024, 4:03pm UTC](https://discuss.openedx.org/t/documentation-for-xblock-asides/12433/6 "2024-03-06T16:03:38Z")

</div>

Looking through the history of Asides, I see that they were developed initially to support tagging of XBlocks. @braden or @dave, do you here know if that is still part of the implementation plan for [Content Tagging](https://openedx.atlassian.net/wiki/spaces/OEPM/pages/3695542440/Content+Tagging+Strategy+for+the+Open+edX+Platform)?

---

<div class="post-metadata">

**Author:** ![pdpinch](https://sea2.discourse-cdn.com/flex020/user_avatar/discuss.openedx.org/pdpinch/32/36_2.png) [@pdpinch](https://discuss.openedx.org/u/pdpinch)\
**Post date:** [March 6, 2024, 4:04pm UTC](https://discuss.openedx.org/t/documentation-for-xblock-asides/12433/7 "2024-03-06T16:04:48Z")

</div>

Thanks @feanil. I think we can add some basic developer documentation here.

---

<div class="post-metadata">

**Author:** ![braden](https://sea2.discourse-cdn.com/flex020/user_avatar/discuss.openedx.org/braden/32/46_2.png) [@braden](https://discuss.openedx.org/u/braden)\
**Post date:** [March 6, 2024, 5:34pm UTC](https://discuss.openedx.org/t/documentation-for-xblock-asides/12433/8 "2024-03-06T17:34:22Z")

</div>

> [@pdpinch](#):
>
> do you here know if that is still part of the implementation plan for [Content Tagging](https://openedx.atlassian.net/wiki/spaces/OEPM/pages/3695542440/Content+Tagging+Strategy+for+the+Open+edX+Platform)?

No, we’re not planning to use asides for any of the new tagging features.

---

<div class="post-metadata">

**Author:** ![feanil](https://sea2.discourse-cdn.com/flex020/user_avatar/discuss.openedx.org/feanil/32/37_2.png) [@feanil](https://discuss.openedx.org/u/feanil)\
**Post date:** [March 6, 2024, 6:28pm UTC](https://discuss.openedx.org/t/documentation-for-xblock-asides/12433/9 "2024-03-06T18:28:17Z")

</div>

@pdpinch it looks like Kyle is adding some more docs as a part of an XBlock refactor PR: [feat!: collapse extraneous XBlock mixins by kdmccormick · Pull Request #718 · openedx/XBlock · GitHub](https://github.com/openedx/XBlock/pull/718) Hopefully, that is a good starting point and you can review and add more to those docs.
