Readme and Log improvements

[nirmal070125]

Purpose

• Readme improvements
• Log level improvements

Summary by CodeRabbit

• Documentation

  • Expanded README with improved project description, features overview, and conceptual model diagrams.
  • Added project badges and table of contents for easier navigation.

• Chores

  • Updated server branding to "OpenFGC."
  • Reduced startup console verbosity by adjusting logging levels.
  • Removed configuration path from startup status output.

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• ✅ Review completed - (🔄 Check again to review again)

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

Tip

Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (3)

consent-server/internal/system/config/config.go (1)

205-205: ⚠️ Potential issue | 🟡 Minor

Inconsistent log level: this Info log should also be Debug.

This line logs at Info level while the surrounding configuration messages (lines 161 and 223) were changed to Debug. For consistency in reducing verbosity, this should also be Debug.

Proposed fix

-	logger.Info("Config file loaded", log.String("file", finalPath))
+	logger.Debug("Config file loaded", log.String("file", finalPath))

start.sh (1)

37-37: ⚠️ Potential issue | 🟡 Minor

Inconsistent branding in help text.

The help text still references "Consent Management Server" while the startup messages were updated to "OpenFGC Server". Consider updating for consistency.

Proposed fix

-            echo "Consent Management Server Startup Script"
+            echo "OpenFGC Server Startup Script"

README.md (1)

82-82: ⚠️ Potential issue | 🟡 Minor

Go version inconsistency and likely typo.

The Technology Stack and Prerequisites sections reference "Go 1.25+" but:

1. The badge on line 9 shows "Go 1.21+"
2. Go 1.25 doesn't exist (as of early 2026, Go is around version 1.22/1.23)

This appears to be a typo and should be "1.21+" to match the badge.

Proposed fix

 ## Technology Stack

-- **Go** 1.25+
+- **Go** 1.21+
 - **Web Framework**: net/http (standard library) with gorilla/mux style routing

 ## Prerequisites

-- Go 1.25 or higher
+- Go 1.21 or higher
 - MySQL 8.0 or higher

Also applies to: 91-91

🧹 Nitpick comments (1)

README.md (1)

44-63: Consider adding a language identifier to the fenced code block.

Static analysis flags this code block as missing a language. Since it's an ASCII diagram, you could use text or plaintext as the language identifier.

Proposed fix

-```
+```text
 ┌───────────────────────────┐