Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add related to topic "Documentation" #3980

Merged
merged 3 commits into from
Oct 13, 2023
Merged

Conversation

shaedrich
Copy link
Contributor

Please confirm this pull request meets the following requirements:

Which change are you proposing?

  • Suggesting edits to an existing topic or collection
  • Curating a new topic or collection
  • Something that does not neatly fit into the binary options above

Editing an existing topic or collection

I'm suggesting these edits to an existing topic or collection:

  • Image (and my file is *.png, square, dimensions 288x288, size <= 75 kB)
  • Content (and my changes are in index.md)

Types of documentation

Curating a new topic or collection

  • I've formatted my changes as a new folder directory, named for the topic or collection as it appears in the URL on GitHub (e.g. https://github.com/topics/[NAME] or https://github.com/collections/[NAME])
  • My folder contains a *.png image (if applicable) and index.md
  • All required fields in my index.md conform to the Style Guide and API docs: https://github.com/github/explore/tree/main/docs

Please replace this line with an explanation of why you think this topic or collection should be curated.

Something that does not neatly fit into the binary options above

  • My suggested edits are not about an existing topic or collection, or at least not a single one
  • My suggested edits are not about curating a new topic or collection, or at least not a single one
  • My suggested edits conform to the Style Guide and API docs: https://github.com/github/explore/tree/main/docs

Please replace this line with an explanation of your proposed changes.


Please note: we will close your PR without comment if you do not check the boxes above and provide ALL requested information.

@shaedrich shaedrich requested a review from a team as a code owner October 12, 2023 06:13
Copy link
Contributor

@ahpook ahpook left a comment

Choose a reason for hiding this comment

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

1 change, otherwise LGTM

topics/documentation/index.md Outdated Show resolved Hide resolved
Co-authored-by: Eric Sorenson <[email protected]>
@shaedrich shaedrich requested a review from ahpook October 13, 2023 23:31
Copy link
Contributor

@ahpook ahpook left a comment

Choose a reason for hiding this comment

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

Nice!

@ahpook ahpook added this pull request to the merge queue Oct 13, 2023
Merged via the queue into github:main with commit 1a84974 Oct 13, 2023
@shaedrich shaedrich deleted the documentation branch October 13, 2023 23:37
@ahpook
Copy link
Contributor

ahpook commented Oct 14, 2023

@shaedrich i just rebuilt the site, so all the changes you've made recently are live. Thanks so much for these contributions!

Screenshot 2023-10-13 at 5 05 17 PM

@shaedrich
Copy link
Contributor Author

shaedrich commented Oct 14, 2023

@ahpook You're very welcome—always a please to contribute!

Cool, I checked my changes and was wondering if the list parsing was intentional:

Actual Expected
grafik grafik
grafik grafik

Is it just me, or is here something off, too?
grafik
Other topic pages seem to use .container-lg on .topic while git uses .container-xl

@kenyonj
Copy link
Contributor

kenyonj commented Oct 16, 2023

I think there is definitely a bug with the ul/li stuff, looks like we're not building those lists correctly from the markdown.
For the git topic page, I think it's treated differently because there is an associated event in the sidebar, GitHub Universe 2023. Whether or not that's the correct CSS to style that page, I'm not sure, but I think that's the reason that it's different.

@shaedrich
Copy link
Contributor Author

Ah, yeah, makes sense.

@shaedrich
Copy link
Contributor Author

shaedrich commented Oct 18, 2023

@kenyonj @ahpook But if you look at the feed, it's all inside one <ul>, however, delimited by \n:

<p><strong>Backbone.js</strong> supplies structure to JavaScript-heavy applications by providing models with key-value binding and custom events, collections with a rich API of enumerable functions, views with declarative event handling, and connects it all to your existing application over a RESTful JSON interface. Backbone.js was originally extracted from the Rails application <a href="http://www.documentcloud.org/">DocumentCloud</a>. Philosophically, Backbone is an attempt to discover the minimal set of data-structuring (models and collections) and user interface (views and URLs) primitives that are generally useful when building web applications with JavaScript. Backbone is a library, not a framework. Synchronous events are used as the fundamental building block over constantly polling data. The main pars of Backbone are:</p>\n<ul>\n  <li>Events</li>\n  <li>Models – Wraps a row of data in business logic.</li>\n  <li>Collections – A group of models on the client-side, with sorting/filtering/aggregation logic.</li>\n  <li>Router (+ History)</li>\n  <li>Views (+ Client-side Templates) – A logical, re-usable piece of UI. Often, but not always, associated with a model.</li>\n  <li>Sync – Synchronization between frontend and REST API backend</li>\n</ul>\n

@shaedrich
Copy link
Contributor Author

shaedrich commented Oct 25, 2023

@kenyonj @ahpook As far as I can see, that part is not open source, so I can't fix that myself and create a PR, right?

@shaedrich shaedrich mentioned this pull request Jan 11, 2024
13 tasks
@shaedrich
Copy link
Contributor Author

shaedrich commented Jan 11, 2024

Finally addressed that via https://github.com/orgs/community/discussions/86655

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.

3 participants