Skip to content

Move xblock-utils repository docs - #672

Merged
farhan merged 1 commit into
farhan/merge-xblock-utilsfrom
farhan/move-xblock-utils-docs
Sep 25, 2023
Merged

Move xblock-utils repository docs#672
farhan merged 1 commit into
farhan/merge-xblock-utilsfrom
farhan/move-xblock-utils-docs

Conversation

@farhan

@farhan farhan commented Sep 21, 2023

Copy link
Copy Markdown
Contributor

Move xblock-utils repository docs

  • Transform the *.md docs into *.rst docs
  • Remove the bok-choy related test case docs

Related ticket: #675
Related PR: #669

Ref: Open edX Style guide

Full Page Screen Shots
Xblock Utils > index.rst
screenshot-xblock-utils-index
XBlock Utils > Settings and theme support
screenshot-xblock-utils-settings-and-theme-support

@feanil feanil left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, but we've stopped using overlines for headers. Can you update all the headings.

Best reference is here: https://docs.openedx.org/en/latest/documentors/references/quick_reference_rst.html

I've got a PR to update the place you were looking to match: openedx-unsupported/edx-documentation#2187

Comment thread docs/xblock-utils/index.rst Outdated
@farhan
farhan force-pushed the farhan/move-xblock-utils-docs branch from e73e21b to fd85d6a Compare September 22, 2023 05:22
@farhan
farhan requested a review from feanil September 22, 2023 05:25
@farhan
farhan force-pushed the farhan/move-xblock-utils-docs branch from 81ffab8 to fd85d6a Compare September 22, 2023 05:35
@farhan farhan closed this Sep 22, 2023
@farhan farhan reopened this Sep 22, 2023
@farhan
farhan force-pushed the farhan/merge-xblock-utils branch from 94906e0 to 890190a Compare September 25, 2023 06:15
@farhan
farhan force-pushed the farhan/move-xblock-utils-docs branch from fd85d6a to a5ae2c2 Compare September 25, 2023 07:57
@farhan farhan closed this Sep 25, 2023
@farhan
farhan force-pushed the farhan/move-xblock-utils-docs branch from a5ae2c2 to 3304375 Compare September 25, 2023 07:59
@farhan farhan reopened this Sep 25, 2023
@salman2013
salman2013 self-requested a review September 25, 2023 10:43
@farhan
farhan merged commit 3c5cb84 into farhan/merge-xblock-utils Sep 25, 2023
@farhan
farhan deleted the farhan/move-xblock-utils-docs branch September 25, 2023 11:37
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.

Merge openedx/xblock-utils library into openedx/XBlock

3 participants