Update README documentation so it explain full configuration and usage.
The readme MUST follow the template at https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or...

Update project page so it explains features and related modules.
As for the project page:
- create and commit a project-page.html
- ensure the current information does not get lost (rewriting is OK)
- explain features and related modules
- stay concise, and factual, a little bit of marketing language is allowed

Add AGENTS.MD for AI agent specific information.

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:

Comments

batigolix created an issue. See original summary.

batigolix’s picture

Issue summary: View changes
aayushpathak’s picture

working !

aayushpathak’s picture

I have updated the README to include detailed sections for installation, configuration, usage, and features.
Also added an AGENTS.md file for AI-related guidance and improved project page content for clarity and completeness.
Please review.

aayushpathak’s picture

Status: Active » Needs review
batigolix’s picture

Status: Needs review » Needs work

I am sorry, but I should have stated in the description that the readme should follow the template at https://www.drupal.org/docs/develop/managing-a-drupalorg-theme-module-or...
(I ll update the description)

Your changes in the readme do not follow that template. They overwrite sections that were already good.

As for the project page:
- create and commit a project-page.html
- ensure the current information does not get lost (rewriting is OK)
- explain features and related modules

batigolix’s picture

Issue summary: View changes
aayushpathak’s picture

Thanks for the clarification
I have Updated README.md to follow Drupal README template while preserving existing content
Added project-page.html with features and related modules
Ensured existing information is retained and improved for clarity

Please review.

aayushpathak’s picture

Status: Needs work » Needs review
angel_devoeted’s picture

Thanks @aayushpathak for working on this! I took a look at the latest diff. The project-page.html and AGENTS.md look solid, but I just wanted to point out a couple of things:

- The README is still missing the ## INTRODUCTION heading right at the top, which is part of the standard template.
- It looks like the old ## Manage flood table section is still deleted. Like @batigolix mentioned in #7, we should probably keep that original text intact.
- I noticed some changes in tests/src/Kernel/MigrateFloodControlTest.php and ValidateD7MigrationStateTest.php (adding conditionals and phpcs:ignoreFile). Just wondering, is there a specific reason we need to include these test modifications in this documentation issue?

aayushpathak’s picture

Thanks for the feedback.
I have updated the README.md as discussed to align with the Drupal template, including adding the Introduction section and restoring the original “Manage flood table” content.
I have also reverted the changes made to the test files to keep the scope limited to documentation. Those changes were initially made to address pipeline issues, but I understand they are out of scope for this issue.

Please review the updated patch.

angel_devoeted’s picture

Thanks @aayushpathak for the quick update and for reverting the test files! That keeps the MR nice and clean.

The README is looking much closer to the template now. I just noticed two quick things we need to tweak:

- In the restored "Manage flood table" section, the original step-by-step instructions are still missing. To ensure we don't lose that helpful information (as requested in comment #7), could you append the original ### Steps back into that section?
- Just a minor detail to strictly match the Drupal README template: the main headings are traditionally written in ALL CAPS (e.g., ## INTRODUCTION, ## REQUIREMENTS, ## CONFIGURATION, etc.). Would you mind updating the capitalization of the main headers as well?

aayushpathak’s picture

Sorry for the confusion and multiple iterations. I have now addressed all the feedback. Please review the updated patch.

batigolix’s picture

Assigned: Unassigned » batigolix
Status: Needs review » Postponed

Thanks for the attempts. I think you need to understand the module better to make real documentation improvements.

I'll finish this.

batigolix’s picture

Status: Postponed » Needs review

This can be reviewed

batigolix’s picture

Assigned: batigolix » Unassigned
fabianderijk’s picture

Assigned: Unassigned » fabianderijk

I'll take a look at the changes @batigolix

fabianderijk’s picture

Assigned: fabianderijk » batigolix
Status: Needs review » Reviewed & tested by the community

I've reviewed the changes, and everything looks okay too me. @batigolix you can merge this if you want

batigolix’s picture

Status: Reviewed & tested by the community » Fixed

Thanks everybody, for helping out with this one

Now that this issue is closed, review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, credit people who helped resolve this issue.

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.