Skip to content

Conversation

@TalalAhmed31
Copy link

As requested in opencti/opencti#12517 , moving this contribution to the official documentation repository.

Proposed changes

  • Added a frontend-development-guide file as frontend documentation
  • Helps programmers understand the uncommented code and make changes more easily

Related issues

  • N/A

Checklist

  • I consider the submitted work as finished
  • I tested the code for its functionality (documentation build & readability)
  • I added/update the relevant documentation (either on github or on notion)

Further comments

  • Since the frontend code lacks inline comments, I created this dedicated documentation to help new contributors navigate the codebase efficiently.
  • No code logic was modified — this PR is purely documentation-related.

@TalalAhmed31
Copy link
Author

TalalAhmed31 commented Oct 24, 2025

Hi @aHenryJard
I’ve updated the guide to remove the hardcoded color values and now reference the constants instead.
Thanks for your helpful feedback — please let me know if any further adjustments are needed.

@esrevi esrevi self-assigned this Nov 17, 2025
@TalalAhmed31
Copy link
Author

@marieflorescontact Kindly look into this, as I have made all the changes and still awaiting for the response.
CC: @aHenryJard

@marieflorescontact
Copy link
Member

Hi @TalalAhmed31 ,

Thank you for your work 🙂
After discussing this with the team, we’ve decided that we cannot accept this documentation in its current form.

The main reason is that it is too focused on low-level code implementation (e.g. static code snippets, very basic examples such as commenting out a field in a query to exclude it, emphasis on theme/logo customization, etc.) and does not bring enough added value at the documentation level.

For the official OpenCTI documentation, we are looking for content that is more oriented towards higher-level guidelines, for example:

How to properly develop a new module;
Which patterns and best practices should be followed;
How to customize or extend components in a consistent way;
Conceptual overviews and diagrams of workflows and architecture.

Thank you again for your contribution and the time you invested in this PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants