Problem/Motivation

A few improvements to the README.md file, like adding a table of content, fixing a spelling mistake, and adding code formatting to the two CSS files mentioned.

Steps to reproduce

Proposed resolution

Remaining tasks

User interface changes

API changes

Data model changes

CommentFileSizeAuthor
#7 3266787-7-after.png104.73 KBshyam_bhatt

Issue fork bootstrap5-3266787

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

About issue forks

Comments

ressa created an issue. See original summary.

ressa opened merge request !9

ressa’s picture

ressa
he/him
commented
Status: Active » Needs review
vladimiraus’s picture

vladimiraus
Primary language English
Location Brisbane 🇦🇺
commented
Status: Needs review » Needs work

Thanks for initiative @ressa.
The file is not that big so we don't need table to content.

ressa’s picture

ressa
he/him
commented
Status: Needs work » Needs review

I have removed the Table of contents.

And by the way, thanks for this project, it's very nice!

ressa’s picture

ressa
he/him
commented

I was looking through "Needs review" issues, perhaps we can get this finalized before too long?

shyam_bhatt’s picture

shyam_bhatt
he/him
commented
Status: Needs review » Reviewed & tested by the community
StatusFileSize
new 3266787-7-after.png104.73 KB

@ressa I have gone through the updated README.md file looks good.

2022-10-26/3266787-7-after.png

dineshreddymathuku made their first commit to this issue’s fork.

dineshreddymathuku’s picture

dineshreddymathuku commented

Hi @ressa your changes looks good as per markdown standards and #8 please review it once
thanks

Manoj Raj.R made their first commit to this issue’s fork.

Manoj Raj.R’s picture

Manoj Raj.R commented
Status: Reviewed & tested by the community » Needs review

Adding maintainer and small changes.
Please Review it!

ressa’s picture

ressa
he/him
commented

Thanks. @VladimirAus: It would be awesome to get this finalized.

nupur badola’s picture

nupur badola commented
Status: Needs review » Needs work

Reviewed MR!9, the file has following errors:

9.diff.txt:12: trailing whitespace.
This is a very non-prescriptive vanilla Bootstrap 5 theme
warning: 1 line adds whitespace errors.

Kindly follow the instruction mentioned here:  https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or-distribution-project/documenting-your-project/readmemd-template

Anjali Mehta made their first commit to this issue’s fork.

anjali mehta’s picture

anjali mehta commented
Status: Needs work » Needs review
nupur badola’s picture

nupur badola commented
Status: Needs review » Needs work

Reviewed MR!9, There is an issue.
[Project page] and [issue queue] is missing from introduction section.

sakthi_dev made their first commit to this issue’s fork.

sakthi_dev’s picture

sakthi_dev commented
Status: Needs work » Needs review

Added the Project Page and Issue Page in README.md. Please review.

nupur badola’s picture

nupur badola commented
Status: Needs review » Reviewed & tested by the community

Reviewed MR!9, the file updated as per the readme.md file template.
Hence , marking it to RTBC.

ressa’s picture

ressa
he/him
commented

@VladimirAus: It looks like the README is ready, or do you think it needs more work?

nofue’s picture

nofue commented

Oh, there is one more thing:

## INTRODUCTION

This is a very non-prescriptive vanilla Bootstrap 5 theme
with simple configuration. It can be used out of the box or
as a subtheme for creating very flexible web designs with
minimal changes (just override Bootstrap 5 _variables.scss
or this theme's _variables_theme.scss and recompile css!)

Sadly, since 3.0.5 there is no _variables.scss any more. There is _variables_bootstrap.scss and _variables_drupal.scss, in either contrib/bootstrap5/scss or custom/b5subtheme/scss.

vladimiraus’s picture

vladimiraus
Primary language English
Location Brisbane 🇦🇺
commented
Version: 1.1.x-dev » 3.0.x-dev
Status: Reviewed & tested by the community » Needs work

1.1 is no longer in use.
Please update for 3.0.x

ressa’s picture

ressa
he/him
commented
Status: Needs work » Closed (outdated)

It looks like 3.x has a README.md file, so let's close this issue.